From 13a18002f99706d4d5c6b3053ebb1e816fc39720 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Tollar?= Date: Mon, 12 Oct 2026 12:52:29 +0200 Subject: [PATCH 1/2] build(repo): drop schema-less request bodies before generating the client The OpenAPI generator aborts on a request body that declares no schema, which the removed AI chat endpoints on staging now do. Strip such bodies from the merged spec so the client can be regenerated; the per-API specs stay as the backend serves them. jira: F1-2929 risk: low --- Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index f6e436951..1da4a4240 100644 --- a/Makefile +++ b/Makefile @@ -67,10 +67,14 @@ define generate_client ./scripts/generate_client.sh gooddata-$(1)-client -f "/local/schemas/gooddata-$(1)-client.json" endef +# The OpenAPI generator aborts on a request body that declares no schema, so such bodies are +# dropped from the merged spec; the per-API specs stay exactly as the backend serves them. +STRIP_SCHEMALESS_BODIES = .paths |= map_values(map_values(if type == "object" and has("requestBody") and ([.requestBody.content[]?.schema] | all(. == null)) then del(.requestBody) else . end)) + .PHONY: _api-client-generate _api-client-generate: rm -f schemas/gooddata-api-client.json - cat schemas/gooddata-*.json | jq -S -s 'reduce .[] as $$item ({}; . * $$item) + { tags : ( reduce .[].tags as $$item (null; . + $$item) | unique_by(.name) ) }' > "schemas/gooddata-api-client.json" + cat schemas/gooddata-*.json | jq -S -s 'reduce .[] as $$item ({}; . * $$item) + { tags : ( reduce .[].tags as $$item (null; . + $$item) | unique_by(.name) ) }' | jq -S '$(STRIP_SCHEMALESS_BODIES)' > "schemas/gooddata-api-client.json" $(call generate_client,api) .PHONY: api-client From 69269ec7ab04ed202341d0a7f55944521af8341f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vojt=C4=9Bch=20Tollar?= Date: Mon, 12 Oct 2026 08:52:52 +0200 Subject: [PATCH 2/2] chore(gooddata-api-client): regenerate against staging Full regeneration from the staging specs, bringing the client up to the current backend API, including MANAGE_VISUALIZATIONS. Adapts gooddata-sdk: label identifiers now also accept computedAttribute, so their type is passed explicitly, and workspace setting attributes are generated as JsonApiUserSettingInAttributes since the organization setting types diverged. The backend removed the legacy AI chat and search endpoints, so the ComputeService methods calling them now raise NotImplementedError instead of importing the deleted request models. jira: F1-2929 risk: high --- gooddata-api-client/.openapi-generator/FILES | 476 +- gooddata-api-client/README.md | 506 +- gooddata-api-client/docs/AILakeApi.md | 433 +- .../docs/AILakeDatabasesApi.md | 91 +- .../docs/AILakePipeTablesApi.md | 512 - gooddata-api-client/docs/ActionsApi.md | 1693 +- ...VisualizationConfig.md => AfmFlowInput.md} | 11 +- gooddata-api-client/docs/AfmFlowInputAllOf.md | 14 + .../AfmObjectIdentifierLabelIdentifier.md | 2 +- .../docs/AgentControllerApi.md | 24 + .../docs/{AIAgentsApi.md => AgentsApi.md} | 82 +- .../docs/AllowedRelationshipType.md | 15 - .../docs/AnalyticalDashboardControllerApi.md | 10 +- gooddata-api-client/docs/AnalyticsModelApi.md | 110 + .../docs/AttributeControllerApi.md | 19 +- gooddata-api-client/docs/AttributesApi.md | 19 +- gooddata-api-client/docs/AutomationAlert.md | 1 + .../docs/AutomationControllerApi.md | 88 +- gooddata-api-client/docs/AutomationsApi.md | 140 +- gooddata-api-client/docs/CertificationInfo.md | 14 - .../docs/ChangeAnalysisParams.md | 20 - .../docs/ChatHistoryInteraction.md | 25 - .../docs/ChatHistoryRequest.md | 18 - gooddata-api-client/docs/ChatHistoryResult.md | 13 - gooddata-api-client/docs/ChatRequest.md | 23 - gooddata-api-client/docs/ChatResult.md | 22 - gooddata-api-client/docs/ChatUsageResponse.md | 14 - gooddata-api-client/docs/ClusteringConfig.md | 14 - gooddata-api-client/docs/ClusteringResult.md | 6 +- gooddata-api-client/docs/ColumnExpression.md | 14 - gooddata-api-client/docs/ColumnInfo.md | 14 - .../docs/ColumnPartitionConfig.md | 14 - gooddata-api-client/docs/ComputationApi.md | 3 +- .../docs/ComputedAttributeControllerApi.md | 690 + .../docs/ComputedAttributePermissions.md | 14 + .../ComputedAttributePermissionsAssignment.md | 13 + ...ComputedAttributePermissionsForAssignee.md | 14 + ...utedAttributePermissionsForAssigneeRule.md | 14 + .../docs/ComputedAttributesApi.md | 690 + .../docs/ConditionalFormatting.md | 14 + .../ConditionalFormattingAbsoluteDateValue.md | 15 + ...itionalFormattingAbsoluteDateValueAllOf.md | 14 + ...> ConditionalFormattingAttributeTarget.md} | 9 +- ...nditionalFormattingAttributeTargetAllOf.md | 13 + .../docs/ConditionalFormattingCondition.md | 16 + ...nfig.md => ConditionalFormattingFormat.md} | 10 +- ...ter.md => ConditionalFormattingLiteral.md} | 6 +- .../ConditionalFormattingLiteralRangeValue.md | 15 + ...itionalFormattingLiteralRangeValueAllOf.md | 14 + ...d => ConditionalFormattingLiteralValue.md} | 8 +- .../ConditionalFormattingLiteralValueAllOf.md | 13 + .../ConditionalFormattingMeasureTarget.md | 14 + ...ConditionalFormattingMeasureTargetAllOf.md | 13 + .../docs/ConditionalFormattingNoneValue.md | 13 + .../ConditionalFormattingNoneValueAllOf.md | 12 + .../ConditionalFormattingRelativeDateValue.md | 16 + ...itionalFormattingRelativeDateValueAllOf.md | 15 + .../docs/ConditionalFormattingRule.md | 15 + .../docs/ConditionalFormattingTarget.md | 15 + .../docs/ConditionalFormattingValue.md | 17 + .../docs/CreatePipeTableRequest.md | 24 - ...reatePipeTableRequestDistributionConfig.md | 14 - .../docs/CreatePipeTableRequestKeyConfig.md | 13 - .../CreatePipeTableRequestPartitionConfig.md | 16 - .../docs/CreatedVisualization.md | 21 - .../docs/CreatedVisualizationFiltersInner.md | 21 - .../docs/CreatedVisualizations.md | 15 - gooddata-api-client/docs/DashboardContext.md | 14 - gooddata-api-client/docs/DashboardsApi.md | 10 +- gooddata-api-client/docs/DataFiltersApi.md | 10 +- .../docs/DataSourceControllerApi.md | 3 + .../docs/DataSourceDeclarativeAPIsApi.md | 1 + .../docs/DataSourceEntityAPIsApi.md | 3 + .../docs/DataSourceStatisticsApi.md | 8 +- .../docs/DatasetControllerApi.md | 2 +- gooddata-api-client/docs/DatasetsApi.md | 2 +- .../docs/DateAbsoluteFilterAllOf.md | 14 - .../docs/DateRelativeFilter.md | 15 - .../docs/DateRelativeFilterAllOf.md | 15 - gooddata-api-client/docs/DeclarativeAgent.md | 1 + .../docs/DeclarativeAnalyticsLayer.md | 4 + .../docs/DeclarativeAttribute.md | 1 + .../docs/DeclarativeComputedAttribute.md | 30 + .../DeclarativeComputedAttributeContent.md | 15 + .../docs/DeclarativeDataSource.md | 1 + .../docs/DeclarativeDateDataset.md | 1 + gooddata-api-client/docs/DeclarativeLabel.md | 1 + gooddata-api-client/docs/DeclarativeMetric.md | 1 + gooddata-api-client/docs/DeclarativeReport.md | 19 + .../docs/DeclarativeReportPageLayout.md | 16 + .../docs/DeclarativeReportTemplate.md | 16 + .../docs/DeclarativeVisualizationObject.md | 1 + gooddata-api-client/docs/DependsOn.md | 1 + gooddata-api-client/docs/DependsOnAllOf.md | 1 + gooddata-api-client/docs/DimAttribute.md | 15 - .../docs/DistributionConfig.md | 13 - .../docs/DuplicateKeyConfig.md | 14 - gooddata-api-client/docs/ElementsRequest.md | 1 + .../docs/ElementsRequestDependsOnInner.md | 1 + gooddata-api-client/docs/EntitiesApi.md | 10182 ++-- gooddata-api-client/docs/ErrorInfo.md | 14 - gooddata-api-client/docs/ExportRequest.md | 1 + gooddata-api-client/docs/FactControllerApi.md | 6 +- gooddata-api-client/docs/FactsApi.md | 6 +- gooddata-api-client/docs/FailedOperation.md | 2 +- gooddata-api-client/docs/FileFlowInput.md | 15 + ...eMetadataItem.md => FileFlowInputAllOf.md} | 9 +- gooddata-api-client/docs/FilterContextApi.md | 10 +- .../docs/FilterContextControllerApi.md | 10 +- gooddata-api-client/docs/FlowApi.md | 478 + gooddata-api-client/docs/FlowColumn.md | 15 + .../docs/FlowExecutionResponse.md | 13 + gooddata-api-client/docs/FlowInput.md | 18 + .../docs/FlowOperationDescriptor.md | 18 + .../docs/FlowOperationInput.md | 14 + ...eFilterAllOf.md => FlowOperationOutput.md} | 6 +- gooddata-api-client/docs/FlowOperations.md | 13 + gooddata-api-client/docs/FlowRequest.md | 14 + .../docs/FlowResultMetadata.md | 15 + gooddata-api-client/docs/FlowTablePaging.md | 18 + gooddata-api-client/docs/FlowTableResult.md | 15 + .../docs/FlowTransformation.md | 16 + gooddata-api-client/docs/ForecastConfig.md | 15 - gooddata-api-client/docs/FoundObjects.md | 14 - .../docs/GenAiRankingFilter.md | 15 - .../docs/GenAiRankingFilterAllOf.md | 15 - .../docs/GetAiLakeOperation200Response.md | 2 +- .../docs/HashDistributionConfig.md | 15 - gooddata-api-client/docs/ImageExportApi.md | 11 + .../docs/InsightWidgetDescriptor.md | 18 - gooddata-api-client/docs/Instruction.md | 16 + gooddata-api-client/docs/Invitation.md | 16 + .../docs/JsonApiAgentInAttributes.md | 1 + ...onApiAgentInAttributesInstructionsInner.md | 16 + .../docs/JsonApiAgentOutAttributes.md | 1 + .../docs/JsonApiAgentOutDocument.md | 1 + .../docs/JsonApiAgentOutDocumentMeta.md | 12 + .../docs/JsonApiAgentOutListMeta.md | 1 + .../docs/JsonApiAggregatedFactOutDocument.md | 1 + .../docs/JsonApiAggregatedFactOutIncludes.md | 2 +- .../JsonApiAnalyticalDashboardOutDocument.md | 1 + .../JsonApiAnalyticalDashboardOutIncludes.md | 4 +- ...nApiAnalyticalDashboardOutRelationships.md | 1 + ...boardOutRelationshipsComputedAttributes.md | 12 + .../docs/JsonApiApiTokenOutList.md | 2 +- ...ilter.md => JsonApiApiTokenOutListMeta.md} | 4 +- .../JsonApiAttributeHierarchyOutDocument.md | 1 + .../JsonApiAttributeHierarchyOutIncludes.md | 2 +- .../docs/JsonApiAttributeOut.md | 2 +- .../docs/JsonApiAttributeOutAttributes.md | 1 + ...ibuteOutAttributesConditionalFormatting.md | 14 + .../docs/JsonApiAttributeOutDocument.md | 1 + .../docs/JsonApiAttributeOutIncludes.md | 2 +- .../docs/JsonApiAttributeOutMeta.md | 13 + .../docs/JsonApiAttributeOutWithLinks.md | 2 +- .../docs/JsonApiAttributePatchAttributes.md | 1 + .../JsonApiAutomationInAttributesAlert.md | 1 + .../docs/JsonApiAutomationOutDocument.md | 1 + .../docs/JsonApiAutomationOutIncludes.md | 8 +- .../docs/JsonApiAutomationOutRelationships.md | 7 + ...JsonApiAutomationOutRelationshipsFacts.md} | 2 +- .../docs/JsonApiColorPaletteOutList.md | 2 +- .../docs/JsonApiComputedAttributeIn.md | 15 + .../JsonApiComputedAttributeInAttributes.md | 22 + ...piComputedAttributeInAttributesContent.md} | 2 +- ... => JsonApiComputedAttributeInDocument.md} | 5 +- ....md => JsonApiComputedAttributeLinkage.md} | 6 +- .../docs/JsonApiComputedAttributeOut.md | 17 + .../JsonApiComputedAttributeOutAttributes.md | 27 + ...=> JsonApiComputedAttributeOutDocument.md} | 10 +- ...=> JsonApiComputedAttributeOutIncludes.md} | 2 +- .../docs/JsonApiComputedAttributeOutList.md | 16 + ...onApiComputedAttributeOutRelationships.md} | 5 +- .../JsonApiComputedAttributeOutWithLinks.md | 17 + .../docs/JsonApiComputedAttributePatch.md | 15 + ...JsonApiComputedAttributePatchAttributes.md | 22 + .../JsonApiComputedAttributePatchDocument.md | 12 + .../JsonApiComputedAttributePostOptionalId.md | 15 + ...ComputedAttributePostOptionalIdDocument.md | 12 + .../JsonApiComputedAttributeToManyLinkage.md | 12 + .../docs/JsonApiCspDirectiveOutList.md | 2 +- .../JsonApiCustomApplicationSettingOutList.md | 2 +- .../docs/JsonApiCustomGeoCollectionOutList.md | 2 +- ...nApiCustomUserApplicationSettingOutList.md | 2 +- .../docs/JsonApiDashboardPluginOutDocument.md | 1 + .../JsonApiDataSourceIdentifierOutList.md | 2 +- .../docs/JsonApiDataSourceInAttributes.md | 1 + .../docs/JsonApiDataSourceOutAttributes.md | 1 + .../docs/JsonApiDataSourceOutList.md | 2 +- .../docs/JsonApiDataSourcePatchAttributes.md | 1 + .../docs/JsonApiDatasetOutDocument.md | 1 + .../docs/JsonApiDatasetOutRelationships.md | 2 +- .../docs/JsonApiDatasetPatch.md | 2 +- .../docs/JsonApiDatasetPatchAttributes.md | 14 + .../docs/JsonApiDocumentPipeTable.md | 14 - .../docs/JsonApiEntitlementOutList.md | 2 +- ...ortDefinitionInAttributesRequestPayload.md | 1 + .../JsonApiExportDefinitionOutDocument.md | 1 + .../JsonApiExportDefinitionOutIncludes.md | 4 +- .../docs/JsonApiExportTemplateOutList.md | 2 +- gooddata-api-client/docs/JsonApiFactOut.md | 2 +- .../docs/JsonApiFactOutDocument.md | 1 + .../docs/JsonApiFactOutWithLinks.md | 2 +- gooddata-api-client/docs/JsonApiFactPatch.md | 2 +- .../docs/JsonApiFilterContextOutDocument.md | 1 + .../docs/JsonApiFilterContextOutIncludes.md | 8 +- .../JsonApiFilterContextOutRelationships.md | 3 + .../docs/JsonApiFilterViewOutDocument.md | 1 + .../docs/JsonApiFiscalCalendarOutList.md | 2 +- .../docs/JsonApiIdentityProviderOutList.md | 2 +- .../JsonApiIpAllowlistPolicyOutDocument.md | 1 + .../docs/JsonApiItemPipeTable.md | 15 - gooddata-api-client/docs/JsonApiJwkOutList.md | 2 +- ...onApiKnowledgeRecommendationOutDocument.md | 1 + ...onApiKnowledgeRecommendationOutIncludes.md | 4 +- gooddata-api-client/docs/JsonApiLabelOut.md | 2 +- .../docs/JsonApiLabelOutAttributes.md | 1 + ...LabelOutAttributesConditionalFormatting.md | 14 + .../docs/JsonApiLabelOutDocument.md | 1 + .../docs/JsonApiLabelOutWithLinks.md | 2 +- gooddata-api-client/docs/JsonApiLabelPatch.md | 2 +- ...nfig.md => JsonApiLabelPatchAttributes.md} | 9 +- .../docs/JsonApiLlmProviderOutList.md | 2 +- .../docs/JsonApiMemoryItemOutDocument.md | 1 + .../docs/JsonApiMetricInAttributes.md | 3 +- ...MetricInAttributesConditionalFormatting.md | 14 + gooddata-api-client/docs/JsonApiMetricOut.md | 4 +- .../docs/JsonApiMetricOutAttributes.md | 3 +- .../docs/JsonApiMetricOutDocument.md | 3 +- .../docs/JsonApiMetricOutList.md | 2 +- .../docs/JsonApiMetricOutWithLinks.md | 4 +- .../docs/JsonApiMetricPatchAttributes.md | 3 +- ...ApiNotificationChannelIdentifierOutList.md | 2 +- .../docs/JsonApiNotificationChannelOutList.md | 2 +- .../docs/JsonApiOrgMemoryItemOutDocument.md | 1 + .../docs/JsonApiOrganizationOutDocument.md | 1 + .../docs/JsonApiOrganizationSettingOutList.md | 2 +- .../docs/JsonApiParameterOutDocument.md | 1 + gooddata-api-client/docs/JsonApiReportIn.md | 15 + .../docs/JsonApiReportInAttributes.md | 19 + ...veFilter.md => JsonApiReportInDocument.md} | 5 +- gooddata-api-client/docs/JsonApiReportOut.md | 17 + .../docs/JsonApiReportOutAttributes.md | 21 + ...Summary.md => JsonApiReportOutDocument.md} | 10 +- .../docs/JsonApiReportOutList.md | 16 + .../docs/JsonApiReportOutWithLinks.md | 17 + .../docs/JsonApiReportPageLayoutIn.md | 15 + .../JsonApiReportPageLayoutInAttributes.md | 16 + .../docs/JsonApiReportPageLayoutInDocument.md | 12 + .../docs/JsonApiReportPageLayoutOut.md | 17 + .../JsonApiReportPageLayoutOutAttributes.md | 18 + .../JsonApiReportPageLayoutOutDocument.md | 15 + .../docs/JsonApiReportPageLayoutOutList.md | 16 + .../JsonApiReportPageLayoutOutWithLinks.md | 17 + .../docs/JsonApiReportPageLayoutPatch.md | 15 + .../JsonApiReportPageLayoutPatchAttributes.md | 16 + .../JsonApiReportPageLayoutPatchDocument.md | 12 + .../JsonApiReportPageLayoutPostOptionalId.md | 15 + ...iReportPageLayoutPostOptionalIdDocument.md | 12 + .../docs/JsonApiReportPatch.md | 15 + .../docs/JsonApiReportPatchAttributes.md | 19 + ...ilter.md => JsonApiReportPatchDocument.md} | 5 +- .../docs/JsonApiReportPostOptionalId.md | 15 + .../JsonApiReportPostOptionalIdDocument.md | 12 + .../docs/JsonApiReportTemplateIn.md | 15 + ...d => JsonApiReportTemplateInAttributes.md} | 10 +- ....md => JsonApiReportTemplateInDocument.md} | 5 +- .../docs/JsonApiReportTemplateOut.md | 17 + .../JsonApiReportTemplateOutAttributes.md | 18 + ...md => JsonApiReportTemplateOutDocument.md} | 9 +- .../docs/JsonApiReportTemplateOutList.md | 16 + .../docs/JsonApiReportTemplateOutWithLinks.md | 17 + .../docs/JsonApiReportTemplatePatch.md | 15 + .../JsonApiReportTemplatePatchAttributes.md | 16 + .../JsonApiReportTemplatePatchDocument.md | 12 + .../JsonApiReportTemplatePostOptionalId.md | 15 + ...ApiReportTemplatePostOptionalIdDocument.md | 12 + .../docs/JsonApiThemeOutList.md | 2 +- .../docs/JsonApiUserDataFilterOutDocument.md | 1 + .../JsonApiUserDataFilterOutRelationships.md | 3 +- .../docs/JsonApiUserGroupOutDocument.md | 1 + .../docs/JsonApiUserIdentifierOutList.md | 2 +- .../docs/JsonApiUserOutDocument.md | 1 + .../docs/JsonApiUserSettingIn.md | 2 +- .../docs/JsonApiUserSettingInAttributes.md | 13 + .../docs/JsonApiUserSettingOut.md | 2 +- .../docs/JsonApiUserSettingOutList.md | 2 +- .../docs/JsonApiUserSettingOutWithLinks.md | 2 +- .../JsonApiVisualizationObjectInAttributes.md | 1 + ...ObjectInAttributesConditionalFormatting.md | 14 + .../docs/JsonApiVisualizationObjectOut.md | 4 +- ...JsonApiVisualizationObjectOutAttributes.md | 1 + .../JsonApiVisualizationObjectOutDocument.md | 3 +- .../docs/JsonApiVisualizationObjectOutList.md | 2 +- .../JsonApiVisualizationObjectOutWithLinks.md | 4 +- ...onApiVisualizationObjectPatchAttributes.md | 1 + .../JsonApiWorkspaceColorPaletteOutList.md | 2 +- .../JsonApiWorkspaceDataFilterOutDocument.md | 1 + ...piWorkspaceDataFilterSettingOutDocument.md | 1 + .../JsonApiWorkspaceExportTemplateOutList.md | 2 +- .../docs/JsonApiWorkspaceOutDocument.md | 1 + .../docs/JsonApiWorkspaceSettingIn.md | 2 +- .../docs/JsonApiWorkspaceSettingOut.md | 2 +- .../docs/JsonApiWorkspaceSettingOutList.md | 2 +- .../JsonApiWorkspaceSettingOutWithLinks.md | 2 +- .../docs/JsonApiWorkspaceSettingPatch.md | 2 +- .../JsonApiWorkspaceSettingPostOptionalId.md | 2 +- .../docs/JsonApiWorkspaceThemeOutList.md | 2 +- gooddata-api-client/docs/KeyConfig.md | 13 - .../docs/KnowledgeRecommendationsApi.md | 720 + .../docs/LDMDeclarativeAPIsApi.md | 45 + .../docs/LabelControllerApi.md | 21 +- gooddata-api-client/docs/LabelsApi.md | 21 +- gooddata-api-client/docs/LayoutApi.md | 716 + ...omputedAttributePermissionsRequestInner.md | 14 + ...geVisualizationPermissionsRequestInner.md} | 7 +- gooddata-api-client/docs/MemoryItemsApi.md | 1198 + .../docs/MetadataSynchronizationApi.md | 70 + gooddata-api-client/docs/Metric.md | 16 - .../docs/MetricControllerApi.md | 67 +- gooddata-api-client/docs/MetricValueChange.md | 3 +- gooddata-api-client/docs/MetricsApi.md | 67 +- .../docs/NotificationParameter.md | 1 + .../docs/ObjectConditionalFormatting.md | 14 + gooddata-api-client/docs/ObjectReference.md | 13 - gooddata-api-client/docs/ObjectStorageInfo.md | 2 +- ...bservabilityApi.md => ObservabilityApi.md} | 10 +- gooddata-api-client/docs/Operation.md | 2 +- .../docs/OrganizationDeclarativeAPIsApi.md | 198 + gooddata-api-client/docs/ParameterValue.md | 1 + gooddata-api-client/docs/PartitionConfig.md | 13 - gooddata-api-client/docs/PendingOperation.md | 2 +- gooddata-api-client/docs/PermissionsApi.md | 278 + gooddata-api-client/docs/PipeTable.md | 24 - gooddata-api-client/docs/PipeTableSummary.md | 16 - .../docs/RandomDistributionConfig.md | 14 - gooddata-api-client/docs/Reasoning.md | 14 - gooddata-api-client/docs/ReasoningStep.md | 14 - .../docs/RefreshPartitionRequest.md | 13 - .../docs/ReportControllerApi.md | 569 + gooddata-api-client/docs/ReportExportApi.md | 235 + .../docs/ReportExportRequest.md | 17 + .../docs/ReportPageLayoutControllerApi.md | 560 + .../docs/ReportTemplateControllerApi.md | 560 + .../docs/{AIApi.md => ReportsApi.md} | 997 +- .../docs/ResolvedLlmProvider.md | 14 - .../docs/ResolvedLlmProviderAllOf.md | 14 - gooddata-api-client/docs/ResolvedLlms.md | 12 - gooddata-api-client/docs/ResolvedLlmsData.md | 14 - gooddata-api-client/docs/RestrictedObject.md | 14 + .../docs/RichTextWidgetDescriptor.md | 17 - gooddata-api-client/docs/RouteResult.md | 14 - .../docs/SearchRelationshipObject.md | 19 - gooddata-api-client/docs/SearchRequest.md | 22 - gooddata-api-client/docs/SearchResult.md | 15 - .../docs/SearchResultObject.md | 26 - gooddata-api-client/docs/SmartFunctionsApi.md | 380 +- gooddata-api-client/docs/SqlFlowInput.md | 15 + gooddata-api-client/docs/SqlFlowInputAllOf.md | 14 + .../docs/SucceededOperation.md | 2 +- gooddata-api-client/docs/Suggestion.md | 14 - gooddata-api-client/docs/TabularExportApi.md | 21 + .../docs/TabularExportRequest.md | 1 + gooddata-api-client/docs/Thought.md | 13 - .../docs/TimeSlicePartitionConfig.md | 16 - gooddata-api-client/docs/UIContext.md | 13 - gooddata-api-client/docs/UniqueKeyConfig.md | 14 - .../docs/UserAuthorizationApi.md | 73 + gooddata-api-client/docs/UserContext.md | 15 - .../docs/UserDataFilterControllerApi.md | 10 +- .../docs/UserSettingControllerApi.md | 4 +- gooddata-api-client/docs/UserSettingsApi.md | 4 +- gooddata-api-client/docs/ValidateByItem.md | 2 +- .../docs/VisualizationObjectApi.md | 79 +- .../docs/VisualizationObjectControllerApi.md | 79 +- .../docs/VisualizationPermissions.md | 14 + .../VisualizationPermissionsAssignment.md | 13 + .../VisualizationPermissionsForAssignee.md | 14 + ...VisualizationPermissionsForAssigneeRule.md | 14 + .../VisualizationSwitcherWidgetDescriptor.md | 19 - .../docs/WhatIfMeasureAdjustmentConfig.md | 15 - .../docs/WhatIfScenarioConfig.md | 14 - .../docs/WhatIfScenarioItem.md | 14 - .../WorkflowDashboardSummaryRequestDto.md | 15 - .../WorkflowDashboardSummaryResponseDto.md | 14 - .../docs/WorkflowStatusResponseDto.md | 17 - .../docs/WorkspaceSettingControllerApi.md | 6 +- .../docs/WorkspacesDeclarativeAPIsApi.md | 336 + .../docs/WorkspacesSettingsApi.md | 6 +- .../gooddata_api_client/api/__init__.py | 2 +- .../gooddata_api_client/api/actions_api.py | 2762 +- .../api/{ai_agents_api.py => agents_api.py} | 2 +- .../gooddata_api_client/api/ai_lake_api.py | 810 +- .../api/ai_lake_databases_api.py | 158 +- .../analytical_dashboard_controller_api.py | 5 + .../api/attribute_controller_api.py | 2 + .../gooddata_api_client/api/attributes_api.py | 2 + .../api/automation_controller_api.py | 30 + .../api/automations_api.py | 30 + .../api/computed_attribute_controller_api.py | 1312 + .../api/computed_attributes_api.py | 1312 + .../gooddata_api_client/api/dashboards_api.py | 5 + .../api/data_filters_api.py | 5 + .../api/data_source_statistics_api.py | 4 +- .../gooddata_api_client/api/entities_api.py | 13896 +++-- .../api/fact_controller_api.py | 2 + .../gooddata_api_client/api/facts_api.py | 2 + .../api/filter_context_api.py | 15 + .../api/filter_context_controller_api.py | 15 + ...ai_lake_pipe_tables_api.py => flow_api.py} | 511 +- .../api/image_export_api.py | 6 + .../api/knowledge_recommendations_api.py | 1274 + .../api/label_controller_api.py | 2 + .../gooddata_api_client/api/labels_api.py | 2 + .../api/memory_items_api.py | 2241 + .../api/metadata_synchronization_api.py | 156 + .../api/metric_controller_api.py | 8 + .../gooddata_api_client/api/metrics_api.py | 8 + ...ervability_api.py => observability_api.py} | 2 +- .../api/permissions_api.py | 586 + .../api/report_controller_api.py | 1106 + .../api/report_export_api.py | 474 + .../api/report_page_layout_controller_api.py | 1106 + .../api/report_template_controller_api.py | 1106 + .../api/{ai_api.py => reports_api.py} | 1084 +- .../api/smart_functions_api.py | 390 +- .../api/user_authorization_api.py | 132 + .../api/user_data_filter_controller_api.py | 5 + .../api/visualization_object_api.py | 8 + .../visualization_object_controller_api.py | 8 + .../gooddata_api_client/api_client.py | 8 +- .../gooddata_api_client/apis/__init__.py | 19 +- ...filter_absolute_granularity_date_filter.py | 10 - .../model/afm_flow_input.py | 337 + ...ion_config.py => afm_flow_input_all_of.py} | 43 +- .../afm_object_identifier_core_identifier.py | 1 + .../model/afm_object_identifier_identifier.py | 1 + .../afm_object_identifier_label_identifier.py | 11 +- .../model/afm_valid_objects_query.py | 1 + .../model/ai_usage_metadata_item.py | 282 - .../model/allowed_relationship_type.py | 300 - .../model/attribute_negative_filter.py | 327 - .../model/automation_alert.py | 6 + .../model/certification_info.py | 274 - .../model/change_analysis_params.py | 322 - .../model/chat_history_interaction.py | 348 - .../gooddata_api_client/model/chat_request.py | 335 - .../gooddata_api_client/model/chat_result.py | 322 - .../model/chat_usage_response.py | 282 - .../model/clustering_config.py | 276 - .../model/clustering_result.py | 20 +- .../model/column_expression.py | 282 - ...s.py => computed_attribute_permissions.py} | 48 +- ...puted_attribute_permissions_assignment.py} | 30 +- ...uted_attribute_permissions_for_assignee.py | 334 + ...attribute_permissions_for_assignee_rule.py | 334 + ...ry_result.py => conditional_formatting.py} | 40 +- ...itional_formatting_absolute_date_value.py} | 47 +- ..._formatting_absolute_date_value_all_of.py} | 39 +- ...onditional_formatting_attribute_target.py} | 46 +- ...nal_formatting_attribute_target_all_of.py} | 25 +- .../model/conditional_formatting_condition.py | 313 + ...ig.py => conditional_formatting_format.py} | 43 +- ...r.py => conditional_formatting_literal.py} | 6 +- ...ditional_formatting_literal_range_value.py | 333 + ..._formatting_literal_range_value_all_of.py} | 38 +- .../conditional_formatting_literal_value.py | 331 + ...tional_formatting_literal_value_all_of.py} | 37 +- ... conditional_formatting_measure_target.py} | 43 +- ...ional_formatting_measure_target_all_of.py} | 29 +- ...y => conditional_formatting_none_value.py} | 36 +- ...nditional_formatting_none_value_all_of.py} | 21 +- ...itional_formatting_relative_date_value.py} | 40 +- ..._formatting_relative_date_value_all_of.py} | 29 +- .../model/conditional_formatting_rule.py | 288 + .../model/conditional_formatting_target.py | 334 + ...ner.py => conditional_formatting_value.py} | 97 +- .../model/create_pipe_table_request.py | 330 - .../model/date_trunc_partition_config.py | 299 - .../model/declarative_agent.py | 9 + .../model/declarative_analytics_layer.py | 24 + .../model/declarative_attribute.py | 6 + ...n.py => declarative_computed_attribute.py} | 206 +- ...declarative_computed_attribute_content.py} | 6 +- .../model/declarative_data_source.py | 5 + .../model/declarative_date_dataset.py | 6 + .../model/declarative_label.py | 6 + .../model/declarative_metric.py | 6 + ...et_descriptor.py => declarative_report.py} | 92 +- .../model/declarative_report_page_layout.py | 309 + .../model/declarative_report_template.py | 309 + .../model/declarative_setting.py | 7 + ...declarative_single_workspace_permission.py | 1 + .../model/declarative_visualization_object.py | 6 + ...larative_workspace_hierarchy_permission.py | 1 + .../model/dependent_entities_node.py | 1 + .../gooddata_api_client/model/depends_on.py | 8 + .../model/depends_on_all_of.py | 8 + .../model/distribution_config.py | 273 - .../model/elements_request.py | 8 + .../elements_request_depends_on_inner.py | 8 + .../model/entity_identifier.py | 1 + .../gooddata_api_client/model/error_info.py | 276 - .../model/export_request.py | 6 + .../model/failed_operation.py | 7 +- ..._positive_filter.py => file_flow_input.py} | 40 +- ...ey_config.py => file_flow_input_all_of.py} | 32 +- ..._api_item_pipe_table.py => flow_column.py} | 44 +- ..._context.py => flow_execution_response.py} | 28 +- ...uest_partition_config.py => flow_input.py} | 89 +- ...ations.py => flow_operation_descriptor.py} | 72 +- ...column_info.py => flow_operation_input.py} | 26 +- .../{thought.py => flow_operation_output.py} | 22 +- .../model/flow_operations.py | 276 + .../{reasoning_step.py => flow_request.py} | 38 +- ..._descriptor.py => flow_result_metadata.py} | 61 +- ...identification.py => flow_table_paging.py} | 64 +- ..._table_summary.py => flow_table_result.py} | 48 +- .../model/flow_transformation.py | 282 + .../model/forecast_config.py | 282 - .../get_ai_lake_operation200_response.py | 7 +- .../model/granted_permission.py | 4 + .../model/identifier_ref_identifier.py | 4 + .../model/insight_widget_descriptor.py | 307 - .../gooddata_api_client/model/instruction.py | 294 + ...esh_partition_request.py => invitation.py} | 40 +- .../model/json_api_agent_in_attributes.py | 13 + ..._agent_in_attributes_instructions_inner.py | 294 + .../model/json_api_agent_out_attributes.py | 13 + .../model/json_api_agent_out_document.py | 6 + .../model/json_api_agent_out_document_meta.py | 272 + .../model/json_api_agent_out_list_meta.py | 8 + .../json_api_aggregated_fact_out_document.py | 6 + .../json_api_aggregated_fact_out_includes.py | 10 +- ...n_api_analytical_dashboard_out_document.py | 6 + ...n_api_analytical_dashboard_out_includes.py | 23 +- ..._analytical_dashboard_out_relationships.py | 6 + ..._out_relationships_computed_attributes.py} | 28 +- .../model/json_api_api_token_out_list.py | 10 +- ...py => json_api_api_token_out_list_meta.py} | 18 +- ...on_api_attribute_hierarchy_out_document.py | 6 + ...on_api_attribute_hierarchy_out_includes.py | 10 +- .../model/json_api_attribute_out.py | 10 +- .../json_api_attribute_out_attributes.py | 10 + ...e_out_attributes_conditional_formatting.py | 282 + .../model/json_api_attribute_out_document.py | 6 + .../model/json_api_attribute_out_includes.py | 10 +- .../model/json_api_attribute_out_meta.py | 279 + .../json_api_attribute_out_with_links.py | 10 +- .../json_api_attribute_patch_attributes.py | 10 + ...json_api_automation_in_attributes_alert.py | 6 + .../model/json_api_automation_out_document.py | 6 + .../model/json_api_automation_out_includes.py | 54 +- .../json_api_automation_out_relationships.py | 42 + ...api_automation_out_relationships_facts.py} | 6 +- .../model/json_api_color_palette_out_list.py | 10 +- .../model/json_api_computed_attribute_in.py | 298 + ...n_api_computed_attribute_in_attributes.py} | 124 +- ...mputed_attribute_in_attributes_content.py} | 48 +- ...json_api_computed_attribute_in_document.py | 276 + ...=> json_api_computed_attribute_linkage.py} | 25 +- .../model/json_api_computed_attribute_out.py | 310 + ..._api_computed_attribute_out_attributes.py} | 171 +- ...on_api_computed_attribute_out_document.py} | 66 +- ...on_api_computed_attribute_out_includes.py} | 9 +- .../json_api_computed_attribute_out_list.py | 298 + ...i_computed_attribute_out_relationships.py} | 22 +- ...n_api_computed_attribute_out_with_links.py | 361 + .../json_api_computed_attribute_patch.py | 298 + ...pi_computed_attribute_patch_attributes.py} | 119 +- ...n_api_computed_attribute_patch_document.py | 276 + ...api_computed_attribute_post_optional_id.py | 296 + ...ted_attribute_post_optional_id_document.py | 276 + ..._api_computed_attribute_to_many_linkage.py | 292 + .../model/json_api_csp_directive_out_list.py | 10 +- ...api_custom_application_setting_out_list.py | 10 +- ...json_api_custom_geo_collection_out_list.py | 10 +- ...ustom_user_application_setting_out_list.py | 10 +- .../json_api_dashboard_plugin_out_document.py | 6 + ...i_data_source_identifier_out_attributes.py | 1 + ...son_api_data_source_identifier_out_list.py | 10 +- .../json_api_data_source_in_attributes.py | 5 + .../json_api_data_source_out_attributes.py | 5 + .../model/json_api_data_source_out_list.py | 10 +- .../json_api_data_source_patch_attributes.py | 5 + .../model/json_api_dataset_out_document.py | 6 + .../json_api_dataset_out_relationships.py | 10 +- .../model/json_api_dataset_patch.py | 10 +- .../json_api_dataset_patch_attributes.py | 278 + .../model/json_api_entitlement_out_list.py | 10 +- ...efinition_in_attributes_request_payload.py | 6 + ...json_api_export_definition_out_document.py | 6 + ...json_api_export_definition_out_includes.py | 20 +- .../json_api_export_template_out_list.py | 10 +- .../model/json_api_fact_out.py | 10 +- .../model/json_api_fact_out_document.py | 6 + .../model/json_api_fact_out_with_links.py | 10 +- .../model/json_api_fact_patch.py | 10 +- .../json_api_filter_context_out_document.py | 6 + .../json_api_filter_context_out_includes.py | 45 +- ...on_api_filter_context_out_relationships.py | 18 + .../json_api_filter_view_out_document.py | 6 + .../json_api_fiscal_calendar_out_list.py | 10 +- .../json_api_identity_provider_out_list.py | 10 +- ...on_api_ip_allowlist_policy_out_document.py | 6 + .../model/json_api_jwk_out_list.py | 10 +- ...i_knowledge_recommendation_out_document.py | 6 + ...i_knowledge_recommendation_out_includes.py | 20 +- .../model/json_api_label_out.py | 10 +- .../model/json_api_label_out_attributes.py | 6 + ...l_out_attributes_conditional_formatting.py | 282 + .../model/json_api_label_out_document.py | 6 + .../model/json_api_label_out_with_links.py | 10 +- .../model/json_api_label_patch.py | 10 +- .../model/json_api_label_patch_attributes.py | 288 + .../model/json_api_llm_provider_out_list.py | 10 +- .../json_api_memory_item_out_document.py | 6 + .../model/json_api_metric_in_attributes.py | 16 +- ...ic_in_attributes_conditional_formatting.py | 282 + .../model/json_api_metric_out.py | 20 +- .../model/json_api_metric_out_attributes.py | 16 +- .../model/json_api_metric_out_document.py | 16 +- .../model/json_api_metric_out_list.py | 10 +- .../model/json_api_metric_out_with_links.py | 20 +- .../model/json_api_metric_patch_attributes.py | 16 +- ...otification_channel_identifier_out_list.py | 10 +- .../json_api_notification_channel_out_list.py | 10 +- .../json_api_org_memory_item_out_document.py | 6 + .../json_api_organization_out_document.py | 6 + ..._api_organization_setting_in_attributes.py | 7 + .../json_api_organization_setting_out_list.py | 10 +- .../model/json_api_parameter_out_document.py | 6 + ...table_summary.py => json_api_report_in.py} | 38 +- .../model/json_api_report_in_attributes.py | 310 + .../model/json_api_report_in_document.py | 276 + .../model/json_api_report_out.py | 310 + .../model/json_api_report_out_attributes.py | 328 + ...oup.py => json_api_report_out_document.py} | 50 +- ...summary.py => json_api_report_out_list.py} | 66 +- .../model/json_api_report_out_with_links.py | 361 + .../model/json_api_report_page_layout_in.py | 298 + ...on_api_report_page_layout_in_attributes.py | 294 + ...json_api_report_page_layout_in_document.py | 276 + .../model/json_api_report_page_layout_out.py | 310 + ...n_api_report_page_layout_out_attributes.py | 312 + ...son_api_report_page_layout_out_document.py | 296 + .../json_api_report_page_layout_out_list.py | 298 + ...n_api_report_page_layout_out_with_links.py | 361 + .../json_api_report_page_layout_patch.py | 298 + ...api_report_page_layout_patch_attributes.py | 286 + ...n_api_report_page_layout_patch_document.py | 276 + ...api_report_page_layout_post_optional_id.py | 296 + ...t_page_layout_post_optional_id_document.py | 276 + .../{metric.py => json_api_report_patch.py} | 59 +- .../model/json_api_report_patch_attributes.py | 298 + .../model/json_api_report_patch_document.py | 276 + .../model/json_api_report_post_optional_id.py | 296 + ...on_api_report_post_optional_id_document.py | 276 + .../model/json_api_report_template_in.py | 298 + .../json_api_report_template_in_attributes.py | 294 + .../json_api_report_template_in_document.py | 276 + .../model/json_api_report_template_out.py | 310 + ...json_api_report_template_out_attributes.py | 312 + .../json_api_report_template_out_document.py | 296 + .../json_api_report_template_out_list.py | 298 + ...json_api_report_template_out_with_links.py | 361 + .../model/json_api_report_template_patch.py | 298 + ...n_api_report_template_patch_attributes.py} | 56 +- ...json_api_report_template_patch_document.py | 276 + ...on_api_report_template_post_optional_id.py | 296 + ...port_template_post_optional_id_document.py | 276 + .../model/json_api_theme_out_list.py | 10 +- .../json_api_user_data_filter_out_document.py | 6 + .../json_api_user_data_filter_out_includes.py | 3 + ..._api_user_data_filter_out_relationships.py | 16 +- .../model/json_api_user_group_out_document.py | 6 + .../json_api_user_identifier_out_list.py | 10 +- .../model/json_api_user_out_document.py | 6 + .../model/json_api_user_setting_in.py | 10 +- .../json_api_user_setting_in_attributes.py | 329 + .../model/json_api_user_setting_out.py | 10 +- .../model/json_api_user_setting_out_list.py | 10 +- .../json_api_user_setting_out_with_links.py | 10 +- ..._api_visualization_object_in_attributes.py | 10 + ...t_in_attributes_conditional_formatting.py} | 38 +- .../json_api_visualization_object_out.py | 20 +- ...api_visualization_object_out_attributes.py | 10 + ...n_api_visualization_object_out_document.py | 16 +- .../json_api_visualization_object_out_list.py | 10 +- ...api_visualization_object_out_with_links.py | 20 +- ...i_visualization_object_patch_attributes.py | 10 + ...on_api_workspace_color_palette_out_list.py | 10 +- ..._api_workspace_data_filter_out_document.py | 6 + ...kspace_data_filter_setting_out_document.py | 6 + ..._api_workspace_export_template_out_list.py | 10 +- .../model/json_api_workspace_out_document.py | 6 + .../model/json_api_workspace_out_meta.py | 1 + .../model/json_api_workspace_setting_in.py | 10 +- .../model/json_api_workspace_setting_out.py | 10 +- .../json_api_workspace_setting_out_list.py | 10 +- ...on_api_workspace_setting_out_with_links.py | 10 +- .../model/json_api_workspace_setting_patch.py | 10 +- ..._api_workspace_setting_post_optional_id.py | 10 +- .../json_api_workspace_theme_out_list.py | 10 +- .../gooddata_api_client/model/key_config.py | 273 - ...ted_attribute_permissions_request_inner.py | 340 + ...isualization_permissions_request_inner.py} | 55 +- .../model/metric_value_change.py | 20 +- .../model/notification_parameter.py | 4 + ...xt.py => object_conditional_formatting.py} | 40 +- .../model/object_storage_info.py | 4 +- .../gooddata_api_client/model/operation.py | 7 +- .../model/parameter_value.py | 4 + .../model/partition_config.py | 273 - .../model/pending_operation.py | 7 +- .../gooddata_api_client/model/pipe_table.py | 346 - .../model/report_export_request.py | 301 + .../model/resolved_setting.py | 7 + ...{dim_attribute.py => restricted_object.py} | 34 +- .../gooddata_api_client/model/route_result.py | 286 - .../model/saved_visualization.py | 276 - .../model/search_relationship_object.py | 312 - .../model/search_request.py | 329 - .../model/set_certification_request.py | 1 + ...ai_ranking_filter.py => sql_flow_input.py} | 50 +- ...key_config.py => sql_flow_input_all_of.py} | 32 +- .../model/succeeded_operation.py | 7 +- .../gooddata_api_client/model/suggestion.py | 276 - .../model/tabular_export_request.py | 6 + .../model/test_definition_request.py | 1 + .../model/time_slice_partition_config.py | 308 - .../model/unique_key_config.py | 279 - .../gooddata_api_client/model/user_context.py | 282 - ...agement_workspace_permission_assignment.py | 2 + .../model/validate_by_item.py | 6 +- .../model/visualization_config.py | 288 - .../model/visualization_permissions.py | 292 + ...> visualization_permissions_assignment.py} | 33 +- .../visualization_permissions_for_assignee.py | 334 + ...alization_permissions_for_assignee_rule.py | 334 + .../model/what_if_scenario_config.py | 282 - .../model/what_if_scenario_item.py | 282 - .../workflow_dashboard_summary_request_dto.py | 282 - ...workflow_dashboard_summary_response_dto.py | 282 - .../model/workflow_status_response_dto.py | 294 - .../model/workspace_permission_assignment.py | 2 + .../gooddata_api_client/models/__init__.py | 221 +- .../content_objects/workspace_setting.py | 8 +- .../src/gooddata_sdk/compute/model/base.py | 2 +- .../src/gooddata_sdk/compute/service.py | 117 +- schemas/gooddata-afm-client.json | 4785 +- schemas/gooddata-api-client.json | 46336 +++++++++------- schemas/gooddata-automation-client.json | 434 +- schemas/gooddata-export-client.json | 678 +- schemas/gooddata-metadata-client.json | 34227 ++++++++---- schemas/gooddata-result-client.json | 4 - schemas/gooddata-scan-client.json | 7 +- 757 files changed, 117510 insertions(+), 62456 deletions(-) delete mode 100644 gooddata-api-client/docs/AILakePipeTablesApi.md rename gooddata-api-client/docs/{VisualizationConfig.md => AfmFlowInput.md} (52%) create mode 100644 gooddata-api-client/docs/AfmFlowInputAllOf.md rename gooddata-api-client/docs/{AIAgentsApi.md => AgentsApi.md} (89%) delete mode 100644 gooddata-api-client/docs/AllowedRelationshipType.md delete mode 100644 gooddata-api-client/docs/CertificationInfo.md delete mode 100644 gooddata-api-client/docs/ChangeAnalysisParams.md delete mode 100644 gooddata-api-client/docs/ChatHistoryInteraction.md delete mode 100644 gooddata-api-client/docs/ChatHistoryRequest.md delete mode 100644 gooddata-api-client/docs/ChatHistoryResult.md delete mode 100644 gooddata-api-client/docs/ChatRequest.md delete mode 100644 gooddata-api-client/docs/ChatResult.md delete mode 100644 gooddata-api-client/docs/ChatUsageResponse.md delete mode 100644 gooddata-api-client/docs/ClusteringConfig.md delete mode 100644 gooddata-api-client/docs/ColumnExpression.md delete mode 100644 gooddata-api-client/docs/ColumnInfo.md delete mode 100644 gooddata-api-client/docs/ColumnPartitionConfig.md create mode 100644 gooddata-api-client/docs/ComputedAttributeControllerApi.md create mode 100644 gooddata-api-client/docs/ComputedAttributePermissions.md create mode 100644 gooddata-api-client/docs/ComputedAttributePermissionsAssignment.md create mode 100644 gooddata-api-client/docs/ComputedAttributePermissionsForAssignee.md create mode 100644 gooddata-api-client/docs/ComputedAttributePermissionsForAssigneeRule.md create mode 100644 gooddata-api-client/docs/ComputedAttributesApi.md create mode 100644 gooddata-api-client/docs/ConditionalFormatting.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValue.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValueAllOf.md rename gooddata-api-client/docs/{ActiveObjectIdentification.md => ConditionalFormattingAttributeTarget.md} (67%) create mode 100644 gooddata-api-client/docs/ConditionalFormattingAttributeTargetAllOf.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingCondition.md rename gooddata-api-client/docs/{DateTruncPartitionConfig.md => ConditionalFormattingFormat.md} (57%) rename gooddata-api-client/docs/{DateAbsoluteFilter.md => ConditionalFormattingLiteral.md} (81%) create mode 100644 gooddata-api-client/docs/ConditionalFormattingLiteralRangeValue.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingLiteralRangeValueAllOf.md rename gooddata-api-client/docs/{AggregateKeyConfig.md => ConditionalFormattingLiteralValue.md} (65%) create mode 100644 gooddata-api-client/docs/ConditionalFormattingLiteralValueAllOf.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingMeasureTarget.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingMeasureTargetAllOf.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingNoneValue.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingNoneValueAllOf.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingRelativeDateValue.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingRelativeDateValueAllOf.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingRule.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingTarget.md create mode 100644 gooddata-api-client/docs/ConditionalFormattingValue.md delete mode 100644 gooddata-api-client/docs/CreatePipeTableRequest.md delete mode 100644 gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md delete mode 100644 gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md delete mode 100644 gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md delete mode 100644 gooddata-api-client/docs/CreatedVisualization.md delete mode 100644 gooddata-api-client/docs/CreatedVisualizationFiltersInner.md delete mode 100644 gooddata-api-client/docs/CreatedVisualizations.md delete mode 100644 gooddata-api-client/docs/DashboardContext.md delete mode 100644 gooddata-api-client/docs/DateAbsoluteFilterAllOf.md delete mode 100644 gooddata-api-client/docs/DateRelativeFilter.md delete mode 100644 gooddata-api-client/docs/DateRelativeFilterAllOf.md create mode 100644 gooddata-api-client/docs/DeclarativeComputedAttribute.md create mode 100644 gooddata-api-client/docs/DeclarativeComputedAttributeContent.md create mode 100644 gooddata-api-client/docs/DeclarativeReport.md create mode 100644 gooddata-api-client/docs/DeclarativeReportPageLayout.md create mode 100644 gooddata-api-client/docs/DeclarativeReportTemplate.md delete mode 100644 gooddata-api-client/docs/DimAttribute.md delete mode 100644 gooddata-api-client/docs/DistributionConfig.md delete mode 100644 gooddata-api-client/docs/DuplicateKeyConfig.md delete mode 100644 gooddata-api-client/docs/ErrorInfo.md create mode 100644 gooddata-api-client/docs/FileFlowInput.md rename gooddata-api-client/docs/{AiUsageMetadataItem.md => FileFlowInputAllOf.md} (62%) create mode 100644 gooddata-api-client/docs/FlowApi.md create mode 100644 gooddata-api-client/docs/FlowColumn.md create mode 100644 gooddata-api-client/docs/FlowExecutionResponse.md create mode 100644 gooddata-api-client/docs/FlowInput.md create mode 100644 gooddata-api-client/docs/FlowOperationDescriptor.md create mode 100644 gooddata-api-client/docs/FlowOperationInput.md rename gooddata-api-client/docs/{AttributePositiveFilterAllOf.md => FlowOperationOutput.md} (80%) create mode 100644 gooddata-api-client/docs/FlowOperations.md create mode 100644 gooddata-api-client/docs/FlowRequest.md create mode 100644 gooddata-api-client/docs/FlowResultMetadata.md create mode 100644 gooddata-api-client/docs/FlowTablePaging.md create mode 100644 gooddata-api-client/docs/FlowTableResult.md create mode 100644 gooddata-api-client/docs/FlowTransformation.md delete mode 100644 gooddata-api-client/docs/ForecastConfig.md delete mode 100644 gooddata-api-client/docs/FoundObjects.md delete mode 100644 gooddata-api-client/docs/GenAiRankingFilter.md delete mode 100644 gooddata-api-client/docs/GenAiRankingFilterAllOf.md delete mode 100644 gooddata-api-client/docs/HashDistributionConfig.md delete mode 100644 gooddata-api-client/docs/InsightWidgetDescriptor.md create mode 100644 gooddata-api-client/docs/Instruction.md create mode 100644 gooddata-api-client/docs/Invitation.md create mode 100644 gooddata-api-client/docs/JsonApiAgentInAttributesInstructionsInner.md create mode 100644 gooddata-api-client/docs/JsonApiAgentOutDocumentMeta.md create mode 100644 gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md rename gooddata-api-client/docs/{Filter.md => JsonApiApiTokenOutListMeta.md} (82%) create mode 100644 gooddata-api-client/docs/JsonApiAttributeOutAttributesConditionalFormatting.md create mode 100644 gooddata-api-client/docs/JsonApiAttributeOutMeta.md rename gooddata-api-client/docs/{JsonApiDatasetOutRelationshipsFacts.md => JsonApiAutomationOutRelationshipsFacts.md} (92%) create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeIn.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeInAttributes.md rename gooddata-api-client/docs/{JsonApiMetricInAttributesContent.md => JsonApiComputedAttributeInAttributesContent.md} (96%) rename gooddata-api-client/docs/{AnomalyDetectionConfig.md => JsonApiComputedAttributeInDocument.md} (79%) rename gooddata-api-client/docs/{ResolvedLlm.md => JsonApiComputedAttributeLinkage.md} (76%) create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeOut.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeOutAttributes.md rename gooddata-api-client/docs/{JsonApiListDocumentPipeTableSummary.md => JsonApiComputedAttributeOutDocument.md} (52%) rename gooddata-api-client/docs/{JsonApiMetricOutIncludes.md => JsonApiComputedAttributeOutIncludes.md} (96%) create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeOutList.md rename gooddata-api-client/docs/{JsonApiMetricOutRelationships.md => JsonApiComputedAttributeOutRelationships.md} (82%) create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeOutWithLinks.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributePatch.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributePatchAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributePatchDocument.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributePostOptionalId.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributePostOptionalIdDocument.md create mode 100644 gooddata-api-client/docs/JsonApiComputedAttributeToManyLinkage.md create mode 100644 gooddata-api-client/docs/JsonApiDatasetPatchAttributes.md delete mode 100644 gooddata-api-client/docs/JsonApiDocumentPipeTable.md delete mode 100644 gooddata-api-client/docs/JsonApiItemPipeTable.md create mode 100644 gooddata-api-client/docs/JsonApiLabelOutAttributesConditionalFormatting.md rename gooddata-api-client/docs/{PrimaryKeyConfig.md => JsonApiLabelPatchAttributes.md} (64%) create mode 100644 gooddata-api-client/docs/JsonApiMetricInAttributesConditionalFormatting.md create mode 100644 gooddata-api-client/docs/JsonApiReportIn.md create mode 100644 gooddata-api-client/docs/JsonApiReportInAttributes.md rename gooddata-api-client/docs/{AttributePositiveFilter.md => JsonApiReportInDocument.md} (83%) create mode 100644 gooddata-api-client/docs/JsonApiReportOut.md create mode 100644 gooddata-api-client/docs/JsonApiReportOutAttributes.md rename gooddata-api-client/docs/{JsonApiItemPipeTableSummary.md => JsonApiReportOutDocument.md} (54%) create mode 100644 gooddata-api-client/docs/JsonApiReportOutList.md create mode 100644 gooddata-api-client/docs/JsonApiReportOutWithLinks.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutIn.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutInAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutInDocument.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutOut.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutOutAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutOutDocument.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutOutList.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutOutWithLinks.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutPatch.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutPatchAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutPatchDocument.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutPostOptionalId.md create mode 100644 gooddata-api-client/docs/JsonApiReportPageLayoutPostOptionalIdDocument.md create mode 100644 gooddata-api-client/docs/JsonApiReportPatch.md create mode 100644 gooddata-api-client/docs/JsonApiReportPatchAttributes.md rename gooddata-api-client/docs/{AttributeNegativeFilter.md => JsonApiReportPatchDocument.md} (82%) create mode 100644 gooddata-api-client/docs/JsonApiReportPostOptionalId.md create mode 100644 gooddata-api-client/docs/JsonApiReportPostOptionalIdDocument.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplateIn.md rename gooddata-api-client/docs/{WidgetDescriptor.md => JsonApiReportTemplateInAttributes.md} (54%) rename gooddata-api-client/docs/{AttributeNegativeFilterAllOf.md => JsonApiReportTemplateInDocument.md} (80%) create mode 100644 gooddata-api-client/docs/JsonApiReportTemplateOut.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplateOutAttributes.md rename gooddata-api-client/docs/{SavedVisualization.md => JsonApiReportTemplateOutDocument.md} (52%) create mode 100644 gooddata-api-client/docs/JsonApiReportTemplateOutList.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplateOutWithLinks.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplatePatch.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplatePatchAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplatePatchDocument.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplatePostOptionalId.md create mode 100644 gooddata-api-client/docs/JsonApiReportTemplatePostOptionalIdDocument.md create mode 100644 gooddata-api-client/docs/JsonApiUserSettingInAttributes.md create mode 100644 gooddata-api-client/docs/JsonApiVisualizationObjectInAttributesConditionalFormatting.md delete mode 100644 gooddata-api-client/docs/KeyConfig.md create mode 100644 gooddata-api-client/docs/KnowledgeRecommendationsApi.md create mode 100644 gooddata-api-client/docs/ManageComputedAttributePermissionsRequestInner.md rename gooddata-api-client/docs/{ObjectReferenceGroup.md => ManageVisualizationPermissionsRequestInner.md} (64%) create mode 100644 gooddata-api-client/docs/MemoryItemsApi.md create mode 100644 gooddata-api-client/docs/MetadataSynchronizationApi.md delete mode 100644 gooddata-api-client/docs/Metric.md create mode 100644 gooddata-api-client/docs/ObjectConditionalFormatting.md delete mode 100644 gooddata-api-client/docs/ObjectReference.md rename gooddata-api-client/docs/{AIObservabilityApi.md => ObservabilityApi.md} (78%) delete mode 100644 gooddata-api-client/docs/PartitionConfig.md delete mode 100644 gooddata-api-client/docs/PipeTable.md delete mode 100644 gooddata-api-client/docs/PipeTableSummary.md delete mode 100644 gooddata-api-client/docs/RandomDistributionConfig.md delete mode 100644 gooddata-api-client/docs/Reasoning.md delete mode 100644 gooddata-api-client/docs/ReasoningStep.md delete mode 100644 gooddata-api-client/docs/RefreshPartitionRequest.md create mode 100644 gooddata-api-client/docs/ReportControllerApi.md create mode 100644 gooddata-api-client/docs/ReportExportApi.md create mode 100644 gooddata-api-client/docs/ReportExportRequest.md create mode 100644 gooddata-api-client/docs/ReportPageLayoutControllerApi.md create mode 100644 gooddata-api-client/docs/ReportTemplateControllerApi.md rename gooddata-api-client/docs/{AIApi.md => ReportsApi.md} (62%) delete mode 100644 gooddata-api-client/docs/ResolvedLlmProvider.md delete mode 100644 gooddata-api-client/docs/ResolvedLlmProviderAllOf.md delete mode 100644 gooddata-api-client/docs/ResolvedLlms.md delete mode 100644 gooddata-api-client/docs/ResolvedLlmsData.md create mode 100644 gooddata-api-client/docs/RestrictedObject.md delete mode 100644 gooddata-api-client/docs/RichTextWidgetDescriptor.md delete mode 100644 gooddata-api-client/docs/RouteResult.md delete mode 100644 gooddata-api-client/docs/SearchRelationshipObject.md delete mode 100644 gooddata-api-client/docs/SearchRequest.md delete mode 100644 gooddata-api-client/docs/SearchResult.md delete mode 100644 gooddata-api-client/docs/SearchResultObject.md create mode 100644 gooddata-api-client/docs/SqlFlowInput.md create mode 100644 gooddata-api-client/docs/SqlFlowInputAllOf.md delete mode 100644 gooddata-api-client/docs/Suggestion.md delete mode 100644 gooddata-api-client/docs/Thought.md delete mode 100644 gooddata-api-client/docs/TimeSlicePartitionConfig.md delete mode 100644 gooddata-api-client/docs/UIContext.md delete mode 100644 gooddata-api-client/docs/UniqueKeyConfig.md delete mode 100644 gooddata-api-client/docs/UserContext.md create mode 100644 gooddata-api-client/docs/VisualizationPermissions.md create mode 100644 gooddata-api-client/docs/VisualizationPermissionsAssignment.md create mode 100644 gooddata-api-client/docs/VisualizationPermissionsForAssignee.md create mode 100644 gooddata-api-client/docs/VisualizationPermissionsForAssigneeRule.md delete mode 100644 gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md delete mode 100644 gooddata-api-client/docs/WhatIfMeasureAdjustmentConfig.md delete mode 100644 gooddata-api-client/docs/WhatIfScenarioConfig.md delete mode 100644 gooddata-api-client/docs/WhatIfScenarioItem.md delete mode 100644 gooddata-api-client/docs/WorkflowDashboardSummaryRequestDto.md delete mode 100644 gooddata-api-client/docs/WorkflowDashboardSummaryResponseDto.md delete mode 100644 gooddata-api-client/docs/WorkflowStatusResponseDto.md rename gooddata-api-client/gooddata_api_client/api/{ai_agents_api.py => agents_api.py} (99%) create mode 100644 gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py rename gooddata-api-client/gooddata_api_client/api/{ai_lake_pipe_tables_api.py => flow_api.py} (66%) create mode 100644 gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/memory_items_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/metadata_synchronization_api.py rename gooddata-api-client/gooddata_api_client/api/{ai_observability_api.py => observability_api.py} (99%) create mode 100644 gooddata-api-client/gooddata_api_client/api/report_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/report_export_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/report_page_layout_controller_api.py create mode 100644 gooddata-api-client/gooddata_api_client/api/report_template_controller_api.py rename gooddata-api-client/gooddata_api_client/api/{ai_api.py => reports_api.py} (79%) create mode 100644 gooddata-api-client/gooddata_api_client/model/afm_flow_input.py rename gooddata-api-client/gooddata_api_client/model/{random_distribution_config.py => afm_flow_input_all_of.py} (90%) delete mode 100644 gooddata-api-client/gooddata_api_client/model/ai_usage_metadata_item.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/allowed_relationship_type.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/certification_info.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/change_analysis_params.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/chat_request.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/chat_result.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/chat_usage_response.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/clustering_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/column_expression.py rename gooddata-api-client/gooddata_api_client/model/{found_objects.py => computed_attribute_permissions.py} (87%) rename gooddata-api-client/gooddata_api_client/model/{anomaly_detection_config.py => computed_attribute_permissions_assignment.py} (94%) create mode 100644 gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee.py create mode 100644 gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee_rule.py rename gooddata-api-client/gooddata_api_client/model/{chat_history_result.py => conditional_formatting.py} (90%) rename gooddata-api-client/gooddata_api_client/model/{create_pipe_table_request_key_config.py => conditional_formatting_absolute_date_value.py} (89%) rename gooddata-api-client/gooddata_api_client/model/{gen_ai_ranking_filter_all_of.py => conditional_formatting_absolute_date_value_all_of.py} (89%) rename gooddata-api-client/gooddata_api_client/model/{resolved_llm_provider.py => conditional_formatting_attribute_target.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{attribute_negative_filter_all_of.py => conditional_formatting_attribute_target_all_of.py} (92%) create mode 100644 gooddata-api-client/gooddata_api_client/model/conditional_formatting_condition.py rename gooddata-api-client/gooddata_api_client/model/{column_partition_config.py => conditional_formatting_format.py} (89%) rename gooddata-api-client/gooddata_api_client/model/{filter.py => conditional_formatting_literal.py} (98%) create mode 100644 gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_range_value.py rename gooddata-api-client/gooddata_api_client/model/{aggregate_key_config.py => conditional_formatting_literal_range_value_all_of.py} (91%) create mode 100644 gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value.py rename gooddata-api-client/gooddata_api_client/model/{resolved_llm_provider_all_of.py => conditional_formatting_literal_value_all_of.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{resolved_llms_data.py => conditional_formatting_measure_target.py} (92%) rename gooddata-api-client/gooddata_api_client/model/{date_absolute_filter_all_of.py => conditional_formatting_measure_target_all_of.py} (92%) rename gooddata-api-client/gooddata_api_client/model/{date_absolute_filter.py => conditional_formatting_none_value.py} (93%) rename gooddata-api-client/gooddata_api_client/model/{attribute_positive_filter_all_of.py => conditional_formatting_none_value_all_of.py} (94%) rename gooddata-api-client/gooddata_api_client/model/{date_relative_filter.py => conditional_formatting_relative_date_value.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{date_relative_filter_all_of.py => conditional_formatting_relative_date_value_all_of.py} (91%) create mode 100644 gooddata-api-client/gooddata_api_client/model/conditional_formatting_rule.py create mode 100644 gooddata-api-client/gooddata_api_client/model/conditional_formatting_target.py rename gooddata-api-client/gooddata_api_client/model/{created_visualization_filters_inner.py => conditional_formatting_value.py} (84%) delete mode 100644 gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py rename gooddata-api-client/gooddata_api_client/model/{created_visualization.py => declarative_computed_attribute.py} (59%) rename gooddata-api-client/gooddata_api_client/model/{json_api_metric_in_attributes_content.py => declarative_computed_attribute_content.py} (98%) rename gooddata-api-client/gooddata_api_client/model/{rich_text_widget_descriptor.py => declarative_report.py} (80%) create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_report_page_layout.py create mode 100644 gooddata-api-client/gooddata_api_client/model/declarative_report_template.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/distribution_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/error_info.py rename gooddata-api-client/gooddata_api_client/model/{attribute_positive_filter.py => file_flow_input.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{duplicate_key_config.py => file_flow_input_all_of.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{json_api_item_pipe_table.py => flow_column.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{ui_context.py => flow_execution_response.py} (94%) rename gooddata-api-client/gooddata_api_client/model/{create_pipe_table_request_partition_config.py => flow_input.py} (84%) rename gooddata-api-client/gooddata_api_client/model/{created_visualizations.py => flow_operation_descriptor.py} (79%) rename gooddata-api-client/gooddata_api_client/model/{column_info.py => flow_operation_input.py} (93%) rename gooddata-api-client/gooddata_api_client/model/{thought.py => flow_operation_output.py} (94%) create mode 100644 gooddata-api-client/gooddata_api_client/model/flow_operations.py rename gooddata-api-client/gooddata_api_client/model/{reasoning_step.py => flow_request.py} (88%) rename gooddata-api-client/gooddata_api_client/model/{widget_descriptor.py => flow_result_metadata.py} (88%) rename gooddata-api-client/gooddata_api_client/model/{active_object_identification.py => flow_table_paging.py} (82%) rename gooddata-api-client/gooddata_api_client/model/{json_api_list_document_pipe_table_summary.py => flow_table_result.py} (87%) create mode 100644 gooddata-api-client/gooddata_api_client/model/flow_transformation.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/forecast_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py create mode 100644 gooddata-api-client/gooddata_api_client/model/instruction.py rename gooddata-api-client/gooddata_api_client/model/{refresh_partition_request.py => invitation.py} (87%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes_instructions_inner.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document_meta.py rename gooddata-api-client/gooddata_api_client/model/{json_api_document_pipe_table.py => json_api_analytical_dashboard_out_relationships_computed_attributes.py} (92%) rename gooddata-api-client/gooddata_api_client/model/{resolved_llms.py => json_api_api_token_out_list_meta.py} (95%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes_conditional_formatting.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_meta.py rename gooddata-api-client/gooddata_api_client/model/{json_api_dataset_out_relationships_facts.py => json_api_automation_out_relationships_facts.py} (98%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in.py rename gooddata-api-client/gooddata_api_client/model/{visualization_switcher_widget_descriptor.py => json_api_computed_attribute_in_attributes.py} (75%) rename gooddata-api-client/gooddata_api_client/model/{what_if_measure_adjustment_config.py => json_api_computed_attribute_in_attributes_content.py} (83%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_document.py rename gooddata-api-client/gooddata_api_client/model/{object_reference.py => json_api_computed_attribute_linkage.py} (93%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out.py rename gooddata-api-client/gooddata_api_client/model/{search_result_object.py => json_api_computed_attribute_out_attributes.py} (68%) rename gooddata-api-client/gooddata_api_client/model/{search_result.py => json_api_computed_attribute_out_document.py} (84%) rename gooddata-api-client/gooddata_api_client/model/{json_api_metric_out_includes.py => json_api_computed_attribute_out_includes.py} (97%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_list.py rename gooddata-api-client/gooddata_api_client/model/{json_api_metric_out_relationships.py => json_api_computed_attribute_out_relationships.py} (91%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_with_links.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch.py rename gooddata-api-client/gooddata_api_client/model/{chat_history_request.py => json_api_computed_attribute_patch_attributes.py} (75%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_post_optional_id.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_post_optional_id_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_to_many_linkage.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes_conditional_formatting.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_label_patch_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_conditional_formatting.py rename gooddata-api-client/gooddata_api_client/model/{json_api_item_pipe_table_summary.py => json_api_report_in.py} (90%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_in_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_in_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_out.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_out_attributes.py rename gooddata-api-client/gooddata_api_client/model/{object_reference_group.py => json_api_report_out_document.py} (85%) rename gooddata-api-client/gooddata_api_client/model/{pipe_table_summary.py => json_api_report_out_list.py} (84%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_out_with_links.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_list.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_with_links.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_post_optional_id.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_post_optional_id_document.py rename gooddata-api-client/gooddata_api_client/model/{metric.py => json_api_report_patch.py} (88%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_patch_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_patch_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_post_optional_id.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_post_optional_id_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_in.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_in_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_in_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_out.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_attributes.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_list.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_with_links.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch.py rename gooddata-api-client/gooddata_api_client/model/{hash_distribution_config.py => json_api_report_template_patch_attributes.py} (86%) create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_post_optional_id.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_report_template_post_optional_id_document.py create mode 100644 gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py rename gooddata-api-client/gooddata_api_client/model/{reasoning.py => json_api_visualization_object_in_attributes_conditional_formatting.py} (89%) delete mode 100644 gooddata-api-client/gooddata_api_client/model/key_config.py create mode 100644 gooddata-api-client/gooddata_api_client/model/manage_computed_attribute_permissions_request_inner.py rename gooddata-api-client/gooddata_api_client/model/{create_pipe_table_request_distribution_config.py => manage_visualization_permissions_request_inner.py} (87%) rename gooddata-api-client/gooddata_api_client/model/{dashboard_context.py => object_conditional_formatting.py} (89%) delete mode 100644 gooddata-api-client/gooddata_api_client/model/partition_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/pipe_table.py create mode 100644 gooddata-api-client/gooddata_api_client/model/report_export_request.py rename gooddata-api-client/gooddata_api_client/model/{dim_attribute.py => restricted_object.py} (91%) delete mode 100644 gooddata-api-client/gooddata_api_client/model/route_result.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/saved_visualization.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/search_relationship_object.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/search_request.py rename gooddata-api-client/gooddata_api_client/model/{gen_ai_ranking_filter.py => sql_flow_input.py} (91%) rename gooddata-api-client/gooddata_api_client/model/{primary_key_config.py => sql_flow_input_all_of.py} (91%) delete mode 100644 gooddata-api-client/gooddata_api_client/model/suggestion.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/unique_key_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/user_context.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/visualization_config.py create mode 100644 gooddata-api-client/gooddata_api_client/model/visualization_permissions.py rename gooddata-api-client/gooddata_api_client/model/{resolved_llm.py => visualization_permissions_assignment.py} (93%) create mode 100644 gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee.py create mode 100644 gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee_rule.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/what_if_scenario_item.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/workflow_dashboard_summary_request_dto.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/workflow_dashboard_summary_response_dto.py delete mode 100644 gooddata-api-client/gooddata_api_client/model/workflow_status_response_dto.py diff --git a/gooddata-api-client/.openapi-generator/FILES b/gooddata-api-client/.openapi-generator/FILES index 9299357ae..9edad2f7b 100644 --- a/gooddata-api-client/.openapi-generator/FILES +++ b/gooddata-api-client/.openapi-generator/FILES @@ -1,13 +1,9 @@ .gitignore README.md docs/AFM.md -docs/AIAgentsApi.md -docs/AIApi.md docs/AILakeApi.md docs/AILakeDatabasesApi.md -docs/AILakePipeTablesApi.md docs/AILakeServicesOperationsApi.md -docs/AIObservabilityApi.md docs/APITokensApi.md docs/AbsoluteDateFilter.md docs/AbsoluteDateFilterAbsoluteDateFilter.md @@ -15,13 +11,14 @@ docs/AbsoluteGranularityDateFilter.md docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md docs/AbstractMeasureValueFilter.md docs/ActionsApi.md -docs/ActiveObjectIdentification.md docs/AdHocAutomation.md docs/AddDatabaseDataSourceRequest.md docs/AddDatabaseDataSourceResponse.md docs/AfmCancelTokens.md docs/AfmExecution.md docs/AfmExecutionResponse.md +docs/AfmFlowInput.md +docs/AfmFlowInputAllOf.md docs/AfmIdentifier.md docs/AfmLocalIdentifier.md docs/AfmObjectIdentifier.md @@ -41,9 +38,8 @@ docs/AfmValidDescendantsResponse.md docs/AfmValidObjectsQuery.md docs/AfmValidObjectsResponse.md docs/AgentControllerApi.md -docs/AggregateKeyConfig.md +docs/AgentsApi.md docs/AggregatedFactControllerApi.md -docs/AiUsageMetadataItem.md docs/AlertAfm.md docs/AlertCondition.md docs/AlertConditionOperand.md @@ -51,7 +47,6 @@ docs/AlertDescription.md docs/AlertEvaluationRow.md docs/AllTimeDateFilter.md docs/AllTimeDateFilterAllTimeDateFilter.md -docs/AllowedRelationshipType.md docs/AmplitudeService.md docs/AnalyticalDashboardControllerApi.md docs/AnalyticsCatalogCreatedBy.md @@ -66,7 +61,6 @@ docs/AnalyzeCsvResponseColumn.md docs/AnalyzeCsvResponseConfig.md docs/AnalyzeStatisticsRequest.md docs/AnomalyDetection.md -docs/AnomalyDetectionConfig.md docs/AnomalyDetectionRequest.md docs/AnomalyDetectionResult.md docs/AnomalyDetectionWrapper.md @@ -97,16 +91,12 @@ docs/AttributeHeaderAttributeHeader.md docs/AttributeHierarchiesApi.md docs/AttributeHierarchyControllerApi.md docs/AttributeItem.md -docs/AttributeNegativeFilter.md -docs/AttributeNegativeFilterAllOf.md docs/AttributePermissions.md docs/AttributePermissionsAssignment.md docs/AttributePermissionsForAssignee.md docs/AttributePermissionsForAssigneeAllOf.md docs/AttributePermissionsForAssigneeRule.md docs/AttributePermissionsForAssigneeRuleAllOf.md -docs/AttributePositiveFilter.md -docs/AttributePositiveFilterAllOf.md docs/AttributeResultHeader.md docs/AttributesApi.md docs/AuthenticationApi.md @@ -147,26 +137,14 @@ docs/CalendarDefinition.md docs/CalendarGranularity.md docs/CalendarTableReference.md docs/CertificationApi.md -docs/CertificationInfo.md -docs/ChangeAnalysisParams.md docs/ChangeAnalysisRequest.md docs/ChangeAnalysisResponse.md docs/ChangeAnalysisResult.md -docs/ChatHistoryInteraction.md -docs/ChatHistoryRequest.md -docs/ChatHistoryResult.md -docs/ChatRequest.md -docs/ChatResult.md -docs/ChatUsageResponse.md -docs/ClusteringConfig.md docs/ClusteringRequest.md docs/ClusteringResult.md docs/ColorPaletteControllerApi.md -docs/ColumnExpression.md -docs/ColumnInfo.md docs/ColumnLocation.md docs/ColumnOverride.md -docs/ColumnPartitionConfig.md docs/ColumnStatistic.md docs/ColumnStatisticWarning.md docs/ColumnStatisticsEntry.md @@ -183,19 +161,39 @@ docs/ComparisonWrapper.md docs/CompoundMeasureValueFilter.md docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md docs/ComputationApi.md +docs/ComputedAttributeControllerApi.md +docs/ComputedAttributePermissions.md +docs/ComputedAttributePermissionsAssignment.md +docs/ComputedAttributePermissionsForAssignee.md +docs/ComputedAttributePermissionsForAssigneeRule.md +docs/ComputedAttributesApi.md +docs/ConditionalFormatting.md +docs/ConditionalFormattingAbsoluteDateValue.md +docs/ConditionalFormattingAbsoluteDateValueAllOf.md +docs/ConditionalFormattingAttributeTarget.md +docs/ConditionalFormattingAttributeTargetAllOf.md +docs/ConditionalFormattingCondition.md +docs/ConditionalFormattingFormat.md +docs/ConditionalFormattingLiteral.md +docs/ConditionalFormattingLiteralRangeValue.md +docs/ConditionalFormattingLiteralRangeValueAllOf.md +docs/ConditionalFormattingLiteralValue.md +docs/ConditionalFormattingLiteralValueAllOf.md +docs/ConditionalFormattingMeasureTarget.md +docs/ConditionalFormattingMeasureTargetAllOf.md +docs/ConditionalFormattingNoneValue.md +docs/ConditionalFormattingNoneValueAllOf.md +docs/ConditionalFormattingRelativeDateValue.md +docs/ConditionalFormattingRelativeDateValueAllOf.md +docs/ConditionalFormattingRule.md +docs/ConditionalFormattingTarget.md +docs/ConditionalFormattingValue.md docs/ContentSlideTemplate.md docs/ConvertGeoFileRequest.md docs/ConvertGeoFileResponse.md docs/CookieSecurityConfigurationApi.md docs/CookieSecurityConfigurationControllerApi.md docs/CoverSlideTemplate.md -docs/CreatePipeTableRequest.md -docs/CreatePipeTableRequestDistributionConfig.md -docs/CreatePipeTableRequestKeyConfig.md -docs/CreatePipeTableRequestPartitionConfig.md -docs/CreatedVisualization.md -docs/CreatedVisualizationFiltersInner.md -docs/CreatedVisualizations.md docs/CspDirectiveControllerApi.md docs/CsvConvertOptions.md docs/CsvConvertOptionsColumnType.md @@ -219,7 +217,6 @@ docs/DashboardCompoundComparisonConditionComparison.md docs/DashboardCompoundConditionItem.md docs/DashboardCompoundRangeCondition.md docs/DashboardCompoundRangeConditionRange.md -docs/DashboardContext.md docs/DashboardDateFilter.md docs/DashboardDateFilterDateFilter.md docs/DashboardDateFilterDateFilterFrom.md @@ -263,12 +260,7 @@ docs/DatasetGrain.md docs/DatasetReferenceIdentifier.md docs/DatasetWorkspaceDataFilterIdentifier.md docs/DatasetsApi.md -docs/DateAbsoluteFilter.md -docs/DateAbsoluteFilterAllOf.md docs/DateFilter.md -docs/DateRelativeFilter.md -docs/DateRelativeFilterAllOf.md -docs/DateTruncPartitionConfig.md docs/DateValue.md docs/DeclarativeAgent.md docs/DeclarativeAgents.md @@ -289,6 +281,8 @@ docs/DeclarativeAutomation.md docs/DeclarativeCalendar.md docs/DeclarativeColorPalette.md docs/DeclarativeColumn.md +docs/DeclarativeComputedAttribute.md +docs/DeclarativeComputedAttributeContent.md docs/DeclarativeCspDirective.md docs/DeclarativeCustomApplicationSetting.md docs/DeclarativeCustomGeoCollection.md @@ -329,6 +323,9 @@ docs/DeclarativeOrganizationPermission.md docs/DeclarativeParameter.md docs/DeclarativeReference.md docs/DeclarativeReferenceSource.md +docs/DeclarativeReport.md +docs/DeclarativeReportPageLayout.md +docs/DeclarativeReportTemplate.md docs/DeclarativeRsaSpecification.md docs/DeclarativeSetting.md docs/DeclarativeSingleWorkspacePermission.md @@ -378,11 +375,8 @@ docs/DependsOnDateFilterAllOf.md docs/DependsOnItem.md docs/DependsOnMatchFilter.md docs/DependsOnMatchFilterAllOf.md -docs/DimAttribute.md docs/Dimension.md docs/DimensionHeader.md -docs/DistributionConfig.md -docs/DuplicateKeyConfig.md docs/Element.md docs/ElementsRequest.md docs/ElementsRequestDependsOnInner.md @@ -395,7 +389,6 @@ docs/EntityIdentifier.md docs/EntitySearchBody.md docs/EntitySearchPage.md docs/EntitySearchSort.md -docs/ErrorInfo.md docs/ExecutionLinks.md docs/ExecutionResponse.md docs/ExecutionResult.md @@ -424,7 +417,8 @@ docs/FailedOperationAllOf.md docs/FeatureFlagsContext.md docs/Features.md docs/File.md -docs/Filter.md +docs/FileFlowInput.md +docs/FileFlowInputAllOf.md docs/FilterBy.md docs/FilterContextApi.md docs/FilterContextControllerApi.md @@ -436,16 +430,25 @@ docs/FiscalCalendarControllerApi.md docs/FiscalCalendarsApi.md docs/FiscalYearCalendarDefinition.md docs/FiscalYearCalendarDefinitionAllOf.md -docs/ForecastConfig.md +docs/FlowApi.md +docs/FlowColumn.md +docs/FlowExecutionResponse.md +docs/FlowInput.md +docs/FlowOperationDescriptor.md +docs/FlowOperationInput.md +docs/FlowOperationOutput.md +docs/FlowOperations.md +docs/FlowRequest.md +docs/FlowResultMetadata.md +docs/FlowTablePaging.md +docs/FlowTableResult.md +docs/FlowTransformation.md docs/ForecastRequest.md docs/ForecastResult.md -docs/FoundObjects.md docs/Frequency.md docs/FrequencyBucket.md docs/FrequencyProperties.md docs/GdStorageFile.md -docs/GenAiRankingFilter.md -docs/GenAiRankingFilterAllOf.md docs/GenerateDescriptionRequest.md docs/GenerateDescriptionResponse.md docs/GenerateLdmRequest.md @@ -465,7 +468,6 @@ docs/GetServiceStatusResponse.md docs/GrainIdentifier.md docs/GrantedPermission.md docs/GranularitiesFormatting.md -docs/HashDistributionConfig.md docs/HeaderGroup.md docs/HierarchyApi.md docs/HierarchyObjectIdentification.md @@ -493,20 +495,23 @@ docs/InlineFilterDefinition.md docs/InlineFilterDefinitionInline.md docs/InlineMeasureDefinition.md docs/InlineMeasureDefinitionInline.md -docs/InsightWidgetDescriptor.md +docs/Instruction.md docs/IntroSlideTemplate.md docs/InvalidateCacheApi.md +docs/Invitation.md docs/IpAllowlistPolicyControllerApi.md docs/IpAllowlistPolicyTargets.md docs/JWKSApi.md docs/JsonApiAgentIn.md docs/JsonApiAgentInAttributes.md +docs/JsonApiAgentInAttributesInstructionsInner.md docs/JsonApiAgentInDocument.md docs/JsonApiAgentInRelationships.md docs/JsonApiAgentInRelationshipsUserGroups.md docs/JsonApiAgentOut.md docs/JsonApiAgentOutAttributes.md docs/JsonApiAgentOutDocument.md +docs/JsonApiAgentOutDocumentMeta.md docs/JsonApiAgentOutIncludes.md docs/JsonApiAgentOutList.md docs/JsonApiAgentOutListMeta.md @@ -542,6 +547,7 @@ docs/JsonApiAnalyticalDashboardOutMeta.md docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md docs/JsonApiAnalyticalDashboardOutRelationships.md docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md +docs/JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md @@ -563,6 +569,7 @@ docs/JsonApiApiTokenOut.md docs/JsonApiApiTokenOutAttributes.md docs/JsonApiApiTokenOutDocument.md docs/JsonApiApiTokenOutList.md +docs/JsonApiApiTokenOutListMeta.md docs/JsonApiApiTokenOutWithLinks.md docs/JsonApiAttributeHierarchyIn.md docs/JsonApiAttributeHierarchyInAttributes.md @@ -582,9 +589,11 @@ docs/JsonApiAttributeHierarchyToManyLinkage.md docs/JsonApiAttributeLinkage.md docs/JsonApiAttributeOut.md docs/JsonApiAttributeOutAttributes.md +docs/JsonApiAttributeOutAttributesConditionalFormatting.md docs/JsonApiAttributeOutDocument.md docs/JsonApiAttributeOutIncludes.md docs/JsonApiAttributeOutList.md +docs/JsonApiAttributeOutMeta.md docs/JsonApiAttributeOutRelationships.md docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md docs/JsonApiAttributeOutRelationshipsDefaultView.md @@ -621,6 +630,7 @@ docs/JsonApiAutomationOutIncludes.md docs/JsonApiAutomationOutList.md docs/JsonApiAutomationOutRelationships.md docs/JsonApiAutomationOutRelationshipsAutomationResults.md +docs/JsonApiAutomationOutRelationshipsFacts.md docs/JsonApiAutomationOutWithLinks.md docs/JsonApiAutomationPatch.md docs/JsonApiAutomationPatchDocument.md @@ -643,6 +653,24 @@ docs/JsonApiColorPaletteOutWithLinks.md docs/JsonApiColorPalettePatch.md docs/JsonApiColorPalettePatchAttributes.md docs/JsonApiColorPalettePatchDocument.md +docs/JsonApiComputedAttributeIn.md +docs/JsonApiComputedAttributeInAttributes.md +docs/JsonApiComputedAttributeInAttributesContent.md +docs/JsonApiComputedAttributeInDocument.md +docs/JsonApiComputedAttributeLinkage.md +docs/JsonApiComputedAttributeOut.md +docs/JsonApiComputedAttributeOutAttributes.md +docs/JsonApiComputedAttributeOutDocument.md +docs/JsonApiComputedAttributeOutIncludes.md +docs/JsonApiComputedAttributeOutList.md +docs/JsonApiComputedAttributeOutRelationships.md +docs/JsonApiComputedAttributeOutWithLinks.md +docs/JsonApiComputedAttributePatch.md +docs/JsonApiComputedAttributePatchAttributes.md +docs/JsonApiComputedAttributePatchDocument.md +docs/JsonApiComputedAttributePostOptionalId.md +docs/JsonApiComputedAttributePostOptionalIdDocument.md +docs/JsonApiComputedAttributeToManyLinkage.md docs/JsonApiCookieSecurityConfigurationIn.md docs/JsonApiCookieSecurityConfigurationInAttributes.md docs/JsonApiCookieSecurityConfigurationInDocument.md @@ -737,15 +765,14 @@ docs/JsonApiDatasetOutIncludes.md docs/JsonApiDatasetOutList.md docs/JsonApiDatasetOutRelationships.md docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md -docs/JsonApiDatasetOutRelationshipsFacts.md docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md docs/JsonApiDatasetOutWithLinks.md docs/JsonApiDatasetPatch.md +docs/JsonApiDatasetPatchAttributes.md docs/JsonApiDatasetPatchDocument.md docs/JsonApiDatasetToManyLinkage.md docs/JsonApiDatasetToOneLinkage.md docs/JsonApiDocumentDatabaseInstance.md -docs/JsonApiDocumentPipeTable.md docs/JsonApiEntitlementOut.md docs/JsonApiEntitlementOutAttributes.md docs/JsonApiEntitlementOutDocument.md @@ -855,8 +882,6 @@ docs/JsonApiIpAllowlistPolicyOutWithLinks.md docs/JsonApiItemDataSourceInfo.md docs/JsonApiItemDatabaseInstance.md docs/JsonApiItemObjectStorageInfo.md -docs/JsonApiItemPipeTable.md -docs/JsonApiItemPipeTableSummary.md docs/JsonApiItemServiceInfo.md docs/JsonApiJwkIn.md docs/JsonApiJwkInAttributes.md @@ -888,6 +913,7 @@ docs/JsonApiKnowledgeRecommendationPostOptionalIdDocument.md docs/JsonApiLabelLinkage.md docs/JsonApiLabelOut.md docs/JsonApiLabelOutAttributes.md +docs/JsonApiLabelOutAttributesConditionalFormatting.md docs/JsonApiLabelOutAttributesGeoAreaConfig.md docs/JsonApiLabelOutAttributesTranslationsInner.md docs/JsonApiLabelOutDocument.md @@ -895,13 +921,13 @@ docs/JsonApiLabelOutList.md docs/JsonApiLabelOutRelationships.md docs/JsonApiLabelOutWithLinks.md docs/JsonApiLabelPatch.md +docs/JsonApiLabelPatchAttributes.md docs/JsonApiLabelPatchDocument.md docs/JsonApiLabelToManyLinkage.md docs/JsonApiLabelToOneLinkage.md docs/JsonApiListDocumentDataSourceInfo.md docs/JsonApiListDocumentDatabaseInstance.md docs/JsonApiListDocumentObjectStorageInfo.md -docs/JsonApiListDocumentPipeTableSummary.md docs/JsonApiListDocumentServiceInfo.md docs/JsonApiListLinks.md docs/JsonApiListMeta.md @@ -931,15 +957,13 @@ docs/JsonApiMemoryItemPostOptionalId.md docs/JsonApiMemoryItemPostOptionalIdDocument.md docs/JsonApiMetricIn.md docs/JsonApiMetricInAttributes.md -docs/JsonApiMetricInAttributesContent.md +docs/JsonApiMetricInAttributesConditionalFormatting.md docs/JsonApiMetricInDocument.md docs/JsonApiMetricLinkage.md docs/JsonApiMetricOut.md docs/JsonApiMetricOutAttributes.md docs/JsonApiMetricOutDocument.md -docs/JsonApiMetricOutIncludes.md docs/JsonApiMetricOutList.md -docs/JsonApiMetricOutRelationships.md docs/JsonApiMetricOutWithLinks.md docs/JsonApiMetricPatch.md docs/JsonApiMetricPatchAttributes.md @@ -1020,6 +1044,45 @@ docs/JsonApiParameterPatchDocument.md docs/JsonApiParameterPostOptionalId.md docs/JsonApiParameterPostOptionalIdDocument.md docs/JsonApiParameterToManyLinkage.md +docs/JsonApiReportIn.md +docs/JsonApiReportInAttributes.md +docs/JsonApiReportInDocument.md +docs/JsonApiReportOut.md +docs/JsonApiReportOutAttributes.md +docs/JsonApiReportOutDocument.md +docs/JsonApiReportOutList.md +docs/JsonApiReportOutWithLinks.md +docs/JsonApiReportPageLayoutIn.md +docs/JsonApiReportPageLayoutInAttributes.md +docs/JsonApiReportPageLayoutInDocument.md +docs/JsonApiReportPageLayoutOut.md +docs/JsonApiReportPageLayoutOutAttributes.md +docs/JsonApiReportPageLayoutOutDocument.md +docs/JsonApiReportPageLayoutOutList.md +docs/JsonApiReportPageLayoutOutWithLinks.md +docs/JsonApiReportPageLayoutPatch.md +docs/JsonApiReportPageLayoutPatchAttributes.md +docs/JsonApiReportPageLayoutPatchDocument.md +docs/JsonApiReportPageLayoutPostOptionalId.md +docs/JsonApiReportPageLayoutPostOptionalIdDocument.md +docs/JsonApiReportPatch.md +docs/JsonApiReportPatchAttributes.md +docs/JsonApiReportPatchDocument.md +docs/JsonApiReportPostOptionalId.md +docs/JsonApiReportPostOptionalIdDocument.md +docs/JsonApiReportTemplateIn.md +docs/JsonApiReportTemplateInAttributes.md +docs/JsonApiReportTemplateInDocument.md +docs/JsonApiReportTemplateOut.md +docs/JsonApiReportTemplateOutAttributes.md +docs/JsonApiReportTemplateOutDocument.md +docs/JsonApiReportTemplateOutList.md +docs/JsonApiReportTemplateOutWithLinks.md +docs/JsonApiReportTemplatePatch.md +docs/JsonApiReportTemplatePatchAttributes.md +docs/JsonApiReportTemplatePatchDocument.md +docs/JsonApiReportTemplatePostOptionalId.md +docs/JsonApiReportTemplatePostOptionalIdDocument.md docs/JsonApiThemeIn.md docs/JsonApiThemeInDocument.md docs/JsonApiThemeOut.md @@ -1074,6 +1137,7 @@ docs/JsonApiUserOutWithLinks.md docs/JsonApiUserPatch.md docs/JsonApiUserPatchDocument.md docs/JsonApiUserSettingIn.md +docs/JsonApiUserSettingInAttributes.md docs/JsonApiUserSettingInDocument.md docs/JsonApiUserSettingOut.md docs/JsonApiUserSettingOutDocument.md @@ -1083,6 +1147,7 @@ docs/JsonApiUserToManyLinkage.md docs/JsonApiUserToOneLinkage.md docs/JsonApiVisualizationObjectIn.md docs/JsonApiVisualizationObjectInAttributes.md +docs/JsonApiVisualizationObjectInAttributesConditionalFormatting.md docs/JsonApiVisualizationObjectInDocument.md docs/JsonApiVisualizationObjectLinkage.md docs/JsonApiVisualizationObjectOut.md @@ -1191,12 +1256,12 @@ docs/JsonApiWorkspaceThemePatchDocument.md docs/JsonApiWorkspaceToOneLinkage.md docs/JsonNode.md docs/JwkControllerApi.md -docs/KeyConfig.md docs/KeyDriversDimension.md docs/KeyDriversRequest.md docs/KeyDriversResponse.md docs/KeyDriversResult.md docs/KnowledgeRecommendationControllerApi.md +docs/KnowledgeRecommendationsApi.md docs/LDMDeclarativeAPIsApi.md docs/LLMEndpointsApi.md docs/LLMProvidersApi.md @@ -1221,11 +1286,13 @@ docs/LlmProviderControllerApi.md docs/LocalIdentifier.md docs/LocaleRequest.md docs/ManageAttributePermissionsRequestInner.md +docs/ManageComputedAttributePermissionsRequestInner.md docs/ManageDashboardPermissionsRequestInner.md docs/ManageFactPermissionsRequestInner.md docs/ManageLabelPermissionsRequestInner.md docs/ManageMetricPermissionsRequestInner.md docs/ManagePermissionsApi.md +docs/ManageVisualizationPermissionsRequestInner.md docs/MatchAttributeFilter.md docs/MatchAttributeFilterMatchAttributeFilter.md docs/MatomoService.md @@ -1240,7 +1307,8 @@ docs/MeasureValueFilter.md docs/MemoryItemControllerApi.md docs/MemoryItemCreatedByUsers.md docs/MemoryItemUser.md -docs/Metric.md +docs/MemoryItemsApi.md +docs/MetadataSynchronizationApi.md docs/MetricControllerApi.md docs/MetricDefinitionOverride.md docs/MetricPermissions.md @@ -1270,11 +1338,11 @@ docs/NotificationsMetaTotal.md docs/NumberConstraints.md docs/NumberParameterDefinition.md docs/OGCAPIFeaturesApi.md +docs/ObjectConditionalFormatting.md docs/ObjectLinks.md docs/ObjectLinksContainer.md -docs/ObjectReference.md -docs/ObjectReferenceGroup.md docs/ObjectStorageInfo.md +docs/ObservabilityApi.md docs/OpenAIProviderConfig.md docs/OpenAiApiKeyAuth.md docs/OpenAiApiKeyAuthAllOf.md @@ -1306,7 +1374,6 @@ docs/ParameterDefinition.md docs/ParameterItem.md docs/ParameterValue.md docs/ParametersApi.md -docs/PartitionConfig.md docs/PdfTableStyle.md docs/PdfTableStyleProperty.md docs/PdmLdmRequest.md @@ -1316,8 +1383,6 @@ docs/PermissionsApi.md docs/PermissionsAssignment.md docs/PermissionsForAssignee.md docs/PermissionsForAssigneeRule.md -docs/PipeTable.md -docs/PipeTableSummary.md docs/PlatformUsage.md docs/PlatformUsageRequest.md docs/PluginsApi.md @@ -1330,7 +1395,6 @@ docs/PopDateMeasureDefinitionOverPeriodMeasure.md docs/PopMeasureDefinition.md docs/PositiveAttributeFilter.md docs/PositiveAttributeFilterPositiveAttributeFilter.md -docs/PrimaryKeyConfig.md docs/Profile.md docs/ProfileFeatures.md docs/ProfileLinks.md @@ -1338,7 +1402,6 @@ docs/ProvisionDatabaseInstanceRequest.md docs/QualityIssue.md docs/QualityIssueObject.md docs/QualityIssuesCalculationStatusResponse.md -docs/RandomDistributionConfig.md docs/Range.md docs/RangeCondition.md docs/RangeConditionRange.md @@ -1356,47 +1419,39 @@ docs/RawExportRequest.md docs/ReadCsvFileManifestsRequest.md docs/ReadCsvFileManifestsRequestItem.md docs/ReadCsvFileManifestsResponse.md -docs/Reasoning.md -docs/ReasoningStep.md docs/ReferenceIdentifier.md docs/ReferenceSourceColumn.md -docs/RefreshPartitionRequest.md docs/Relative.md docs/RelativeBoundedDateFilter.md docs/RelativeDateFilter.md docs/RelativeDateFilterRelativeDateFilter.md docs/RelativeWrapper.md docs/RemoveDatabaseDataSourceResponse.md +docs/ReportControllerApi.md +docs/ReportExportApi.md +docs/ReportExportRequest.md +docs/ReportPageLayoutControllerApi.md +docs/ReportTemplateControllerApi.md docs/ReportingSettingsApi.md +docs/ReportsApi.md docs/ResolveSettingsRequest.md -docs/ResolvedLlm.md -docs/ResolvedLlmProvider.md -docs/ResolvedLlmProviderAllOf.md -docs/ResolvedLlms.md -docs/ResolvedLlmsData.md docs/ResolvedSetting.md docs/RestApiIdentifier.md +docs/RestrictedObject.md docs/ResultCacheMetadata.md docs/ResultDimension.md docs/ResultDimensionHeader.md docs/ResultSpec.md -docs/RichTextWidgetDescriptor.md -docs/RouteResult.md docs/RsaSpecification.md docs/RulePermission.md docs/RunServiceCommandRequest.md docs/RunningSection.md -docs/SavedVisualization.md docs/ScanRequest.md docs/ScanResultPdm.md docs/ScanSqlRequest.md docs/ScanSqlResponse.md docs/ScanningApi.md docs/ScheduleCacheRetention.md -docs/SearchRelationshipObject.md -docs/SearchRequest.md -docs/SearchResult.md -docs/SearchResultObject.md docs/SectionSlideTemplate.md docs/ServiceInfo.md docs/SetCertificationRequest.md @@ -1419,6 +1474,8 @@ docs/SortKeyValue.md docs/SortKeyValueValue.md docs/SourceReferenceIdentifier.md docs/SqlColumn.md +docs/SqlFlowInput.md +docs/SqlFlowInputAllOf.md docs/SqlQuery.md docs/SqlQueryAllOf.md docs/StaticFeatures.md @@ -1428,7 +1485,6 @@ docs/StringParameterAllowedValue.md docs/StringParameterDefinition.md docs/SucceededOperation.md docs/SucceededOperationAllOf.md -docs/Suggestion.md docs/SwitchIdentityProviderRequest.md docs/Table.md docs/TableAllOf.md @@ -1456,8 +1512,6 @@ docs/TestQueryDuration.md docs/TestRequest.md docs/TestResponse.md docs/ThemeControllerApi.md -docs/Thought.md -docs/TimeSlicePartitionConfig.md docs/Total.md docs/TotalDimension.md docs/TotalExecutionResultHeader.md @@ -1467,8 +1521,6 @@ docs/TrendingObjectItem.md docs/TrendingObjectsResult.md docs/TriggerAutomationRequest.md docs/TriggerQualityIssuesCalculationResponse.md -docs/UIContext.md -docs/UniqueKeyConfig.md docs/UpdateDatabaseDataSourceRequest.md docs/UpdateDatabaseDataSourceResponse.md docs/UploadFileResponse.md @@ -1476,7 +1528,6 @@ docs/UploadGeoCollectionFileResponse.md docs/UsageApi.md docs/UserAssignee.md docs/UserAuthorizationApi.md -docs/UserContext.md docs/UserControllerApi.md docs/UserDataFilterControllerApi.md docs/UserDataFiltersApi.md @@ -1509,25 +1560,20 @@ docs/Value.md docs/VisibleFilter.md docs/VisualExportApi.md docs/VisualExportRequest.md -docs/VisualizationConfig.md docs/VisualizationObjectApi.md docs/VisualizationObjectControllerApi.md docs/VisualizationObjectExecution.md -docs/VisualizationSwitcherWidgetDescriptor.md +docs/VisualizationPermissions.md +docs/VisualizationPermissionsAssignment.md +docs/VisualizationPermissionsForAssignee.md +docs/VisualizationPermissionsForAssigneeRule.md docs/Webhook.md docs/WebhookAllOf.md docs/WebhookAutomationInfo.md docs/WebhookMessage.md docs/WebhookMessageData.md docs/WebhookRecipient.md -docs/WhatIfMeasureAdjustmentConfig.md -docs/WhatIfScenarioConfig.md -docs/WhatIfScenarioItem.md -docs/WidgetDescriptor.md docs/WidgetSlidesTemplate.md -docs/WorkflowDashboardSummaryRequestDto.md -docs/WorkflowDashboardSummaryResponseDto.md -docs/WorkflowStatusResponseDto.md docs/WorkspaceAutomationIdentifier.md docs/WorkspaceAutomationManagementBulkRequest.md docs/WorkspaceCacheSettings.md @@ -1557,14 +1603,11 @@ gooddata_api_client/__init__.py gooddata_api_client/api/__init__.py gooddata_api_client/api/actions_api.py gooddata_api_client/api/agent_controller_api.py +gooddata_api_client/api/agents_api.py gooddata_api_client/api/aggregated_fact_controller_api.py -gooddata_api_client/api/ai_agents_api.py -gooddata_api_client/api/ai_api.py gooddata_api_client/api/ai_lake_api.py gooddata_api_client/api/ai_lake_databases_api.py -gooddata_api_client/api/ai_lake_pipe_tables_api.py gooddata_api_client/api/ai_lake_services_operations_api.py -gooddata_api_client/api/ai_observability_api.py gooddata_api_client/api/analytical_dashboard_controller_api.py gooddata_api_client/api/analytics_model_api.py gooddata_api_client/api/api_token_controller_api.py @@ -1584,6 +1627,8 @@ gooddata_api_client/api/cache_usage_api.py gooddata_api_client/api/certification_api.py gooddata_api_client/api/color_palette_controller_api.py gooddata_api_client/api/computation_api.py +gooddata_api_client/api/computed_attribute_controller_api.py +gooddata_api_client/api/computed_attributes_api.py gooddata_api_client/api/cookie_security_configuration_api.py gooddata_api_client/api/cookie_security_configuration_controller_api.py gooddata_api_client/api/csp_directive_controller_api.py @@ -1623,6 +1668,7 @@ gooddata_api_client/api/filter_view_controller_api.py gooddata_api_client/api/filter_views_api.py gooddata_api_client/api/fiscal_calendar_controller_api.py gooddata_api_client/api/fiscal_calendars_api.py +gooddata_api_client/api/flow_api.py gooddata_api_client/api/generate_logical_data_model_api.py gooddata_api_client/api/geographic_data_api.py gooddata_api_client/api/hierarchy_api.py @@ -1634,6 +1680,7 @@ gooddata_api_client/api/ip_allowlist_policy_controller_api.py gooddata_api_client/api/jwk_controller_api.py gooddata_api_client/api/jwks_api.py gooddata_api_client/api/knowledge_recommendation_controller_api.py +gooddata_api_client/api/knowledge_recommendations_api.py gooddata_api_client/api/label_controller_api.py gooddata_api_client/api/labels_api.py gooddata_api_client/api/layout_api.py @@ -1643,11 +1690,14 @@ gooddata_api_client/api/llm_provider_controller_api.py gooddata_api_client/api/llm_providers_api.py gooddata_api_client/api/manage_permissions_api.py gooddata_api_client/api/memory_item_controller_api.py +gooddata_api_client/api/memory_items_api.py +gooddata_api_client/api/metadata_synchronization_api.py gooddata_api_client/api/metric_controller_api.py gooddata_api_client/api/metrics_api.py gooddata_api_client/api/notification_channel_controller_api.py gooddata_api_client/api/notification_channel_identifier_controller_api.py gooddata_api_client/api/notification_channels_api.py +gooddata_api_client/api/observability_api.py gooddata_api_client/api/ogcapi_features_api.py gooddata_api_client/api/options_api.py gooddata_api_client/api/org_memory_item_controller_api.py @@ -1660,7 +1710,12 @@ 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/raw_export_api.py +gooddata_api_client/api/report_controller_api.py +gooddata_api_client/api/report_export_api.py +gooddata_api_client/api/report_page_layout_controller_api.py +gooddata_api_client/api/report_template_controller_api.py gooddata_api_client/api/reporting_settings_api.py +gooddata_api_client/api/reports_api.py gooddata_api_client/api/scanning_api.py gooddata_api_client/api/slides_export_api.py gooddata_api_client/api/smart_functions_api.py @@ -1706,7 +1761,6 @@ gooddata_api_client/model/absolute_date_filter_absolute_date_filter.py gooddata_api_client/model/absolute_granularity_date_filter.py gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py gooddata_api_client/model/abstract_measure_value_filter.py -gooddata_api_client/model/active_object_identification.py gooddata_api_client/model/ad_hoc_automation.py gooddata_api_client/model/add_database_data_source_request.py gooddata_api_client/model/add_database_data_source_response.py @@ -1714,6 +1768,8 @@ gooddata_api_client/model/afm.py gooddata_api_client/model/afm_cancel_tokens.py gooddata_api_client/model/afm_execution.py gooddata_api_client/model/afm_execution_response.py +gooddata_api_client/model/afm_flow_input.py +gooddata_api_client/model/afm_flow_input_all_of.py gooddata_api_client/model/afm_identifier.py gooddata_api_client/model/afm_local_identifier.py gooddata_api_client/model/afm_object_identifier.py @@ -1732,8 +1788,6 @@ gooddata_api_client/model/afm_valid_descendants_query.py gooddata_api_client/model/afm_valid_descendants_response.py gooddata_api_client/model/afm_valid_objects_query.py gooddata_api_client/model/afm_valid_objects_response.py -gooddata_api_client/model/aggregate_key_config.py -gooddata_api_client/model/ai_usage_metadata_item.py gooddata_api_client/model/alert_afm.py gooddata_api_client/model/alert_condition.py gooddata_api_client/model/alert_condition_operand.py @@ -1741,7 +1795,6 @@ gooddata_api_client/model/alert_description.py gooddata_api_client/model/alert_evaluation_row.py gooddata_api_client/model/all_time_date_filter.py gooddata_api_client/model/all_time_date_filter_all_time_date_filter.py -gooddata_api_client/model/allowed_relationship_type.py gooddata_api_client/model/amplitude_service.py gooddata_api_client/model/analytics_catalog_created_by.py gooddata_api_client/model/analytics_catalog_tags.py @@ -1754,7 +1807,6 @@ gooddata_api_client/model/analyze_csv_response_column.py gooddata_api_client/model/analyze_csv_response_config.py gooddata_api_client/model/analyze_statistics_request.py gooddata_api_client/model/anomaly_detection.py -gooddata_api_client/model/anomaly_detection_config.py gooddata_api_client/model/anomaly_detection_request.py gooddata_api_client/model/anomaly_detection_result.py gooddata_api_client/model/anomaly_detection_wrapper.py @@ -1780,16 +1832,12 @@ gooddata_api_client/model/attribute_format.py gooddata_api_client/model/attribute_header.py gooddata_api_client/model/attribute_header_attribute_header.py gooddata_api_client/model/attribute_item.py -gooddata_api_client/model/attribute_negative_filter.py -gooddata_api_client/model/attribute_negative_filter_all_of.py gooddata_api_client/model/attribute_permissions.py gooddata_api_client/model/attribute_permissions_assignment.py gooddata_api_client/model/attribute_permissions_for_assignee.py gooddata_api_client/model/attribute_permissions_for_assignee_all_of.py gooddata_api_client/model/attribute_permissions_for_assignee_rule.py gooddata_api_client/model/attribute_permissions_for_assignee_rule_all_of.py -gooddata_api_client/model/attribute_positive_filter.py -gooddata_api_client/model/attribute_positive_filter_all_of.py gooddata_api_client/model/attribute_result_header.py gooddata_api_client/model/automation_alert.py gooddata_api_client/model/automation_dashboard_tabular_export.py @@ -1820,25 +1868,13 @@ gooddata_api_client/model/cache_usage_data.py gooddata_api_client/model/calendar_definition.py gooddata_api_client/model/calendar_granularity.py gooddata_api_client/model/calendar_table_reference.py -gooddata_api_client/model/certification_info.py -gooddata_api_client/model/change_analysis_params.py gooddata_api_client/model/change_analysis_request.py gooddata_api_client/model/change_analysis_response.py gooddata_api_client/model/change_analysis_result.py -gooddata_api_client/model/chat_history_interaction.py -gooddata_api_client/model/chat_history_request.py -gooddata_api_client/model/chat_history_result.py -gooddata_api_client/model/chat_request.py -gooddata_api_client/model/chat_result.py -gooddata_api_client/model/chat_usage_response.py -gooddata_api_client/model/clustering_config.py gooddata_api_client/model/clustering_request.py gooddata_api_client/model/clustering_result.py -gooddata_api_client/model/column_expression.py -gooddata_api_client/model/column_info.py gooddata_api_client/model/column_location.py gooddata_api_client/model/column_override.py -gooddata_api_client/model/column_partition_config.py gooddata_api_client/model/column_statistic.py gooddata_api_client/model/column_statistic_warning.py gooddata_api_client/model/column_statistics_entry.py @@ -1854,17 +1890,35 @@ gooddata_api_client/model/comparison_measure_value_filter_comparison_measure_val gooddata_api_client/model/comparison_wrapper.py gooddata_api_client/model/compound_measure_value_filter.py gooddata_api_client/model/compound_measure_value_filter_compound_measure_value_filter.py +gooddata_api_client/model/computed_attribute_permissions.py +gooddata_api_client/model/computed_attribute_permissions_assignment.py +gooddata_api_client/model/computed_attribute_permissions_for_assignee.py +gooddata_api_client/model/computed_attribute_permissions_for_assignee_rule.py +gooddata_api_client/model/conditional_formatting.py +gooddata_api_client/model/conditional_formatting_absolute_date_value.py +gooddata_api_client/model/conditional_formatting_absolute_date_value_all_of.py +gooddata_api_client/model/conditional_formatting_attribute_target.py +gooddata_api_client/model/conditional_formatting_attribute_target_all_of.py +gooddata_api_client/model/conditional_formatting_condition.py +gooddata_api_client/model/conditional_formatting_format.py +gooddata_api_client/model/conditional_formatting_literal.py +gooddata_api_client/model/conditional_formatting_literal_range_value.py +gooddata_api_client/model/conditional_formatting_literal_range_value_all_of.py +gooddata_api_client/model/conditional_formatting_literal_value.py +gooddata_api_client/model/conditional_formatting_literal_value_all_of.py +gooddata_api_client/model/conditional_formatting_measure_target.py +gooddata_api_client/model/conditional_formatting_measure_target_all_of.py +gooddata_api_client/model/conditional_formatting_none_value.py +gooddata_api_client/model/conditional_formatting_none_value_all_of.py +gooddata_api_client/model/conditional_formatting_relative_date_value.py +gooddata_api_client/model/conditional_formatting_relative_date_value_all_of.py +gooddata_api_client/model/conditional_formatting_rule.py +gooddata_api_client/model/conditional_formatting_target.py +gooddata_api_client/model/conditional_formatting_value.py gooddata_api_client/model/content_slide_template.py gooddata_api_client/model/convert_geo_file_request.py gooddata_api_client/model/convert_geo_file_response.py gooddata_api_client/model/cover_slide_template.py -gooddata_api_client/model/create_pipe_table_request.py -gooddata_api_client/model/create_pipe_table_request_distribution_config.py -gooddata_api_client/model/create_pipe_table_request_key_config.py -gooddata_api_client/model/create_pipe_table_request_partition_config.py -gooddata_api_client/model/created_visualization.py -gooddata_api_client/model/created_visualization_filters_inner.py -gooddata_api_client/model/created_visualizations.py gooddata_api_client/model/csv_convert_options.py gooddata_api_client/model/csv_convert_options_column_type.py gooddata_api_client/model/csv_manifest_body.py @@ -1884,7 +1938,6 @@ gooddata_api_client/model/dashboard_compound_comparison_condition_comparison.py gooddata_api_client/model/dashboard_compound_condition_item.py gooddata_api_client/model/dashboard_compound_range_condition.py gooddata_api_client/model/dashboard_compound_range_condition_range.py -gooddata_api_client/model/dashboard_context.py gooddata_api_client/model/dashboard_date_filter.py gooddata_api_client/model/dashboard_date_filter_date_filter.py gooddata_api_client/model/dashboard_date_filter_date_filter_from.py @@ -1912,12 +1965,7 @@ gooddata_api_client/model/database_instance.py gooddata_api_client/model/dataset_grain.py gooddata_api_client/model/dataset_reference_identifier.py gooddata_api_client/model/dataset_workspace_data_filter_identifier.py -gooddata_api_client/model/date_absolute_filter.py -gooddata_api_client/model/date_absolute_filter_all_of.py gooddata_api_client/model/date_filter.py -gooddata_api_client/model/date_relative_filter.py -gooddata_api_client/model/date_relative_filter_all_of.py -gooddata_api_client/model/date_trunc_partition_config.py gooddata_api_client/model/date_value.py gooddata_api_client/model/declarative_agent.py gooddata_api_client/model/declarative_agents.py @@ -1938,6 +1986,8 @@ gooddata_api_client/model/declarative_automation.py gooddata_api_client/model/declarative_calendar.py gooddata_api_client/model/declarative_color_palette.py gooddata_api_client/model/declarative_column.py +gooddata_api_client/model/declarative_computed_attribute.py +gooddata_api_client/model/declarative_computed_attribute_content.py gooddata_api_client/model/declarative_csp_directive.py gooddata_api_client/model/declarative_custom_application_setting.py gooddata_api_client/model/declarative_custom_geo_collection.py @@ -1978,6 +2028,9 @@ gooddata_api_client/model/declarative_organization_permission.py gooddata_api_client/model/declarative_parameter.py gooddata_api_client/model/declarative_reference.py gooddata_api_client/model/declarative_reference_source.py +gooddata_api_client/model/declarative_report.py +gooddata_api_client/model/declarative_report_page_layout.py +gooddata_api_client/model/declarative_report_template.py gooddata_api_client/model/declarative_rsa_specification.py gooddata_api_client/model/declarative_setting.py gooddata_api_client/model/declarative_single_workspace_permission.py @@ -2026,11 +2079,8 @@ gooddata_api_client/model/depends_on_date_filter_all_of.py gooddata_api_client/model/depends_on_item.py gooddata_api_client/model/depends_on_match_filter.py gooddata_api_client/model/depends_on_match_filter_all_of.py -gooddata_api_client/model/dim_attribute.py gooddata_api_client/model/dimension.py gooddata_api_client/model/dimension_header.py -gooddata_api_client/model/distribution_config.py -gooddata_api_client/model/duplicate_key_config.py gooddata_api_client/model/element.py gooddata_api_client/model/elements_request.py gooddata_api_client/model/elements_request_depends_on_inner.py @@ -2040,7 +2090,6 @@ gooddata_api_client/model/entity_identifier.py gooddata_api_client/model/entity_search_body.py gooddata_api_client/model/entity_search_page.py gooddata_api_client/model/entity_search_sort.py -gooddata_api_client/model/error_info.py gooddata_api_client/model/execution_links.py gooddata_api_client/model/execution_response.py gooddata_api_client/model/execution_result.py @@ -2063,22 +2112,31 @@ gooddata_api_client/model/failed_operation_all_of.py gooddata_api_client/model/feature_flags_context.py gooddata_api_client/model/features.py gooddata_api_client/model/file.py -gooddata_api_client/model/filter.py +gooddata_api_client/model/file_flow_input.py +gooddata_api_client/model/file_flow_input_all_of.py gooddata_api_client/model/filter_by.py gooddata_api_client/model/filter_definition.py gooddata_api_client/model/filter_definition_for_simple_measure.py gooddata_api_client/model/fiscal_year_calendar_definition.py gooddata_api_client/model/fiscal_year_calendar_definition_all_of.py -gooddata_api_client/model/forecast_config.py +gooddata_api_client/model/flow_column.py +gooddata_api_client/model/flow_execution_response.py +gooddata_api_client/model/flow_input.py +gooddata_api_client/model/flow_operation_descriptor.py +gooddata_api_client/model/flow_operation_input.py +gooddata_api_client/model/flow_operation_output.py +gooddata_api_client/model/flow_operations.py +gooddata_api_client/model/flow_request.py +gooddata_api_client/model/flow_result_metadata.py +gooddata_api_client/model/flow_table_paging.py +gooddata_api_client/model/flow_table_result.py +gooddata_api_client/model/flow_transformation.py gooddata_api_client/model/forecast_request.py gooddata_api_client/model/forecast_result.py -gooddata_api_client/model/found_objects.py gooddata_api_client/model/frequency.py gooddata_api_client/model/frequency_bucket.py gooddata_api_client/model/frequency_properties.py gooddata_api_client/model/gd_storage_file.py -gooddata_api_client/model/gen_ai_ranking_filter.py -gooddata_api_client/model/gen_ai_ranking_filter_all_of.py gooddata_api_client/model/generate_description_request.py gooddata_api_client/model/generate_description_response.py gooddata_api_client/model/generate_ldm_request.py @@ -2096,7 +2154,6 @@ gooddata_api_client/model/get_service_status_response.py gooddata_api_client/model/grain_identifier.py gooddata_api_client/model/granted_permission.py gooddata_api_client/model/granularities_formatting.py -gooddata_api_client/model/hash_distribution_config.py gooddata_api_client/model/header_group.py gooddata_api_client/model/hierarchy_object_identification.py gooddata_api_client/model/histogram.py @@ -2120,17 +2177,20 @@ gooddata_api_client/model/inline_filter_definition.py gooddata_api_client/model/inline_filter_definition_inline.py gooddata_api_client/model/inline_measure_definition.py gooddata_api_client/model/inline_measure_definition_inline.py -gooddata_api_client/model/insight_widget_descriptor.py +gooddata_api_client/model/instruction.py gooddata_api_client/model/intro_slide_template.py +gooddata_api_client/model/invitation.py gooddata_api_client/model/ip_allowlist_policy_targets.py gooddata_api_client/model/json_api_agent_in.py gooddata_api_client/model/json_api_agent_in_attributes.py +gooddata_api_client/model/json_api_agent_in_attributes_instructions_inner.py gooddata_api_client/model/json_api_agent_in_document.py gooddata_api_client/model/json_api_agent_in_relationships.py gooddata_api_client/model/json_api_agent_in_relationships_user_groups.py gooddata_api_client/model/json_api_agent_out.py gooddata_api_client/model/json_api_agent_out_attributes.py gooddata_api_client/model/json_api_agent_out_document.py +gooddata_api_client/model/json_api_agent_out_document_meta.py gooddata_api_client/model/json_api_agent_out_includes.py gooddata_api_client/model/json_api_agent_out_list.py gooddata_api_client/model/json_api_agent_out_list_meta.py @@ -2166,6 +2226,7 @@ gooddata_api_client/model/json_api_analytical_dashboard_out_meta.py gooddata_api_client/model/json_api_analytical_dashboard_out_meta_access_info.py gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_analytical_dashboards.py +gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_computed_attributes.py gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_dashboard_plugins.py gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_datasets.py gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_filter_contexts.py @@ -2187,6 +2248,7 @@ gooddata_api_client/model/json_api_api_token_out.py gooddata_api_client/model/json_api_api_token_out_attributes.py gooddata_api_client/model/json_api_api_token_out_document.py gooddata_api_client/model/json_api_api_token_out_list.py +gooddata_api_client/model/json_api_api_token_out_list_meta.py gooddata_api_client/model/json_api_api_token_out_with_links.py gooddata_api_client/model/json_api_attribute_hierarchy_in.py gooddata_api_client/model/json_api_attribute_hierarchy_in_attributes.py @@ -2206,9 +2268,11 @@ gooddata_api_client/model/json_api_attribute_hierarchy_to_many_linkage.py gooddata_api_client/model/json_api_attribute_linkage.py gooddata_api_client/model/json_api_attribute_out.py gooddata_api_client/model/json_api_attribute_out_attributes.py +gooddata_api_client/model/json_api_attribute_out_attributes_conditional_formatting.py gooddata_api_client/model/json_api_attribute_out_document.py gooddata_api_client/model/json_api_attribute_out_includes.py gooddata_api_client/model/json_api_attribute_out_list.py +gooddata_api_client/model/json_api_attribute_out_meta.py gooddata_api_client/model/json_api_attribute_out_relationships.py gooddata_api_client/model/json_api_attribute_out_relationships_attribute_hierarchies.py gooddata_api_client/model/json_api_attribute_out_relationships_default_view.py @@ -2245,6 +2309,7 @@ gooddata_api_client/model/json_api_automation_out_includes.py gooddata_api_client/model/json_api_automation_out_list.py gooddata_api_client/model/json_api_automation_out_relationships.py gooddata_api_client/model/json_api_automation_out_relationships_automation_results.py +gooddata_api_client/model/json_api_automation_out_relationships_facts.py gooddata_api_client/model/json_api_automation_out_with_links.py gooddata_api_client/model/json_api_automation_patch.py gooddata_api_client/model/json_api_automation_patch_document.py @@ -2267,6 +2332,24 @@ gooddata_api_client/model/json_api_color_palette_out_with_links.py gooddata_api_client/model/json_api_color_palette_patch.py gooddata_api_client/model/json_api_color_palette_patch_attributes.py gooddata_api_client/model/json_api_color_palette_patch_document.py +gooddata_api_client/model/json_api_computed_attribute_in.py +gooddata_api_client/model/json_api_computed_attribute_in_attributes.py +gooddata_api_client/model/json_api_computed_attribute_in_attributes_content.py +gooddata_api_client/model/json_api_computed_attribute_in_document.py +gooddata_api_client/model/json_api_computed_attribute_linkage.py +gooddata_api_client/model/json_api_computed_attribute_out.py +gooddata_api_client/model/json_api_computed_attribute_out_attributes.py +gooddata_api_client/model/json_api_computed_attribute_out_document.py +gooddata_api_client/model/json_api_computed_attribute_out_includes.py +gooddata_api_client/model/json_api_computed_attribute_out_list.py +gooddata_api_client/model/json_api_computed_attribute_out_relationships.py +gooddata_api_client/model/json_api_computed_attribute_out_with_links.py +gooddata_api_client/model/json_api_computed_attribute_patch.py +gooddata_api_client/model/json_api_computed_attribute_patch_attributes.py +gooddata_api_client/model/json_api_computed_attribute_patch_document.py +gooddata_api_client/model/json_api_computed_attribute_post_optional_id.py +gooddata_api_client/model/json_api_computed_attribute_post_optional_id_document.py +gooddata_api_client/model/json_api_computed_attribute_to_many_linkage.py gooddata_api_client/model/json_api_cookie_security_configuration_in.py gooddata_api_client/model/json_api_cookie_security_configuration_in_attributes.py gooddata_api_client/model/json_api_cookie_security_configuration_in_document.py @@ -2361,15 +2444,14 @@ gooddata_api_client/model/json_api_dataset_out_includes.py gooddata_api_client/model/json_api_dataset_out_list.py gooddata_api_client/model/json_api_dataset_out_relationships.py gooddata_api_client/model/json_api_dataset_out_relationships_aggregated_facts.py -gooddata_api_client/model/json_api_dataset_out_relationships_facts.py gooddata_api_client/model/json_api_dataset_out_relationships_workspace_data_filters.py gooddata_api_client/model/json_api_dataset_out_with_links.py gooddata_api_client/model/json_api_dataset_patch.py +gooddata_api_client/model/json_api_dataset_patch_attributes.py gooddata_api_client/model/json_api_dataset_patch_document.py gooddata_api_client/model/json_api_dataset_to_many_linkage.py gooddata_api_client/model/json_api_dataset_to_one_linkage.py gooddata_api_client/model/json_api_document_database_instance.py -gooddata_api_client/model/json_api_document_pipe_table.py gooddata_api_client/model/json_api_entitlement_out.py gooddata_api_client/model/json_api_entitlement_out_attributes.py gooddata_api_client/model/json_api_entitlement_out_document.py @@ -2479,8 +2561,6 @@ gooddata_api_client/model/json_api_ip_allowlist_policy_out_with_links.py gooddata_api_client/model/json_api_item_data_source_info.py gooddata_api_client/model/json_api_item_database_instance.py gooddata_api_client/model/json_api_item_object_storage_info.py -gooddata_api_client/model/json_api_item_pipe_table.py -gooddata_api_client/model/json_api_item_pipe_table_summary.py gooddata_api_client/model/json_api_item_service_info.py gooddata_api_client/model/json_api_jwk_in.py gooddata_api_client/model/json_api_jwk_in_attributes.py @@ -2512,6 +2592,7 @@ gooddata_api_client/model/json_api_knowledge_recommendation_post_optional_id_doc gooddata_api_client/model/json_api_label_linkage.py gooddata_api_client/model/json_api_label_out.py gooddata_api_client/model/json_api_label_out_attributes.py +gooddata_api_client/model/json_api_label_out_attributes_conditional_formatting.py gooddata_api_client/model/json_api_label_out_attributes_geo_area_config.py gooddata_api_client/model/json_api_label_out_attributes_translations_inner.py gooddata_api_client/model/json_api_label_out_document.py @@ -2519,13 +2600,13 @@ gooddata_api_client/model/json_api_label_out_list.py gooddata_api_client/model/json_api_label_out_relationships.py gooddata_api_client/model/json_api_label_out_with_links.py gooddata_api_client/model/json_api_label_patch.py +gooddata_api_client/model/json_api_label_patch_attributes.py gooddata_api_client/model/json_api_label_patch_document.py gooddata_api_client/model/json_api_label_to_many_linkage.py gooddata_api_client/model/json_api_label_to_one_linkage.py gooddata_api_client/model/json_api_list_document_data_source_info.py gooddata_api_client/model/json_api_list_document_database_instance.py gooddata_api_client/model/json_api_list_document_object_storage_info.py -gooddata_api_client/model/json_api_list_document_pipe_table_summary.py gooddata_api_client/model/json_api_list_document_service_info.py gooddata_api_client/model/json_api_list_links.py gooddata_api_client/model/json_api_list_meta.py @@ -2555,15 +2636,13 @@ gooddata_api_client/model/json_api_memory_item_post_optional_id.py gooddata_api_client/model/json_api_memory_item_post_optional_id_document.py gooddata_api_client/model/json_api_metric_in.py gooddata_api_client/model/json_api_metric_in_attributes.py -gooddata_api_client/model/json_api_metric_in_attributes_content.py +gooddata_api_client/model/json_api_metric_in_attributes_conditional_formatting.py gooddata_api_client/model/json_api_metric_in_document.py gooddata_api_client/model/json_api_metric_linkage.py gooddata_api_client/model/json_api_metric_out.py gooddata_api_client/model/json_api_metric_out_attributes.py gooddata_api_client/model/json_api_metric_out_document.py -gooddata_api_client/model/json_api_metric_out_includes.py gooddata_api_client/model/json_api_metric_out_list.py -gooddata_api_client/model/json_api_metric_out_relationships.py gooddata_api_client/model/json_api_metric_out_with_links.py gooddata_api_client/model/json_api_metric_patch.py gooddata_api_client/model/json_api_metric_patch_attributes.py @@ -2644,6 +2723,45 @@ 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_report_in.py +gooddata_api_client/model/json_api_report_in_attributes.py +gooddata_api_client/model/json_api_report_in_document.py +gooddata_api_client/model/json_api_report_out.py +gooddata_api_client/model/json_api_report_out_attributes.py +gooddata_api_client/model/json_api_report_out_document.py +gooddata_api_client/model/json_api_report_out_list.py +gooddata_api_client/model/json_api_report_out_with_links.py +gooddata_api_client/model/json_api_report_page_layout_in.py +gooddata_api_client/model/json_api_report_page_layout_in_attributes.py +gooddata_api_client/model/json_api_report_page_layout_in_document.py +gooddata_api_client/model/json_api_report_page_layout_out.py +gooddata_api_client/model/json_api_report_page_layout_out_attributes.py +gooddata_api_client/model/json_api_report_page_layout_out_document.py +gooddata_api_client/model/json_api_report_page_layout_out_list.py +gooddata_api_client/model/json_api_report_page_layout_out_with_links.py +gooddata_api_client/model/json_api_report_page_layout_patch.py +gooddata_api_client/model/json_api_report_page_layout_patch_attributes.py +gooddata_api_client/model/json_api_report_page_layout_patch_document.py +gooddata_api_client/model/json_api_report_page_layout_post_optional_id.py +gooddata_api_client/model/json_api_report_page_layout_post_optional_id_document.py +gooddata_api_client/model/json_api_report_patch.py +gooddata_api_client/model/json_api_report_patch_attributes.py +gooddata_api_client/model/json_api_report_patch_document.py +gooddata_api_client/model/json_api_report_post_optional_id.py +gooddata_api_client/model/json_api_report_post_optional_id_document.py +gooddata_api_client/model/json_api_report_template_in.py +gooddata_api_client/model/json_api_report_template_in_attributes.py +gooddata_api_client/model/json_api_report_template_in_document.py +gooddata_api_client/model/json_api_report_template_out.py +gooddata_api_client/model/json_api_report_template_out_attributes.py +gooddata_api_client/model/json_api_report_template_out_document.py +gooddata_api_client/model/json_api_report_template_out_list.py +gooddata_api_client/model/json_api_report_template_out_with_links.py +gooddata_api_client/model/json_api_report_template_patch.py +gooddata_api_client/model/json_api_report_template_patch_attributes.py +gooddata_api_client/model/json_api_report_template_patch_document.py +gooddata_api_client/model/json_api_report_template_post_optional_id.py +gooddata_api_client/model/json_api_report_template_post_optional_id_document.py gooddata_api_client/model/json_api_theme_in.py gooddata_api_client/model/json_api_theme_in_document.py gooddata_api_client/model/json_api_theme_out.py @@ -2698,6 +2816,7 @@ gooddata_api_client/model/json_api_user_out_with_links.py gooddata_api_client/model/json_api_user_patch.py gooddata_api_client/model/json_api_user_patch_document.py gooddata_api_client/model/json_api_user_setting_in.py +gooddata_api_client/model/json_api_user_setting_in_attributes.py gooddata_api_client/model/json_api_user_setting_in_document.py gooddata_api_client/model/json_api_user_setting_out.py gooddata_api_client/model/json_api_user_setting_out_document.py @@ -2707,6 +2826,7 @@ gooddata_api_client/model/json_api_user_to_many_linkage.py gooddata_api_client/model/json_api_user_to_one_linkage.py gooddata_api_client/model/json_api_visualization_object_in.py gooddata_api_client/model/json_api_visualization_object_in_attributes.py +gooddata_api_client/model/json_api_visualization_object_in_attributes_conditional_formatting.py gooddata_api_client/model/json_api_visualization_object_in_document.py gooddata_api_client/model/json_api_visualization_object_linkage.py gooddata_api_client/model/json_api_visualization_object_out.py @@ -2814,7 +2934,6 @@ gooddata_api_client/model/json_api_workspace_theme_patch.py gooddata_api_client/model/json_api_workspace_theme_patch_document.py gooddata_api_client/model/json_api_workspace_to_one_linkage.py gooddata_api_client/model/json_node.py -gooddata_api_client/model/key_config.py gooddata_api_client/model/key_drivers_dimension.py gooddata_api_client/model/key_drivers_request.py gooddata_api_client/model/key_drivers_response.py @@ -2836,10 +2955,12 @@ gooddata_api_client/model/llm_provider_config.py gooddata_api_client/model/local_identifier.py gooddata_api_client/model/locale_request.py gooddata_api_client/model/manage_attribute_permissions_request_inner.py +gooddata_api_client/model/manage_computed_attribute_permissions_request_inner.py gooddata_api_client/model/manage_dashboard_permissions_request_inner.py gooddata_api_client/model/manage_fact_permissions_request_inner.py gooddata_api_client/model/manage_label_permissions_request_inner.py gooddata_api_client/model/manage_metric_permissions_request_inner.py +gooddata_api_client/model/manage_visualization_permissions_request_inner.py gooddata_api_client/model/match_attribute_filter.py gooddata_api_client/model/match_attribute_filter_match_attribute_filter.py gooddata_api_client/model/matomo_service.py @@ -2853,7 +2974,6 @@ gooddata_api_client/model/measure_value_condition.py gooddata_api_client/model/measure_value_filter.py gooddata_api_client/model/memory_item_created_by_users.py gooddata_api_client/model/memory_item_user.py -gooddata_api_client/model/metric.py gooddata_api_client/model/metric_definition_override.py gooddata_api_client/model/metric_permissions.py gooddata_api_client/model/metric_permissions_assignment.py @@ -2877,10 +2997,9 @@ gooddata_api_client/model/notifications_meta.py gooddata_api_client/model/notifications_meta_total.py gooddata_api_client/model/number_constraints.py gooddata_api_client/model/number_parameter_definition.py +gooddata_api_client/model/object_conditional_formatting.py gooddata_api_client/model/object_links.py gooddata_api_client/model/object_links_container.py -gooddata_api_client/model/object_reference.py -gooddata_api_client/model/object_reference_group.py gooddata_api_client/model/object_storage_info.py gooddata_api_client/model/open_ai_api_key_auth.py gooddata_api_client/model/open_ai_api_key_auth_all_of.py @@ -2905,7 +3024,6 @@ gooddata_api_client/model/parameter.py gooddata_api_client/model/parameter_definition.py gooddata_api_client/model/parameter_item.py gooddata_api_client/model/parameter_value.py -gooddata_api_client/model/partition_config.py gooddata_api_client/model/pdf_table_style.py gooddata_api_client/model/pdf_table_style_property.py gooddata_api_client/model/pdm_ldm_request.py @@ -2914,8 +3032,6 @@ gooddata_api_client/model/pending_operation.py gooddata_api_client/model/permissions_assignment.py gooddata_api_client/model/permissions_for_assignee.py gooddata_api_client/model/permissions_for_assignee_rule.py -gooddata_api_client/model/pipe_table.py -gooddata_api_client/model/pipe_table_summary.py gooddata_api_client/model/platform_usage.py gooddata_api_client/model/platform_usage_request.py gooddata_api_client/model/pop_dataset.py @@ -2927,7 +3043,6 @@ gooddata_api_client/model/pop_date_measure_definition_over_period_measure.py gooddata_api_client/model/pop_measure_definition.py gooddata_api_client/model/positive_attribute_filter.py gooddata_api_client/model/positive_attribute_filter_positive_attribute_filter.py -gooddata_api_client/model/primary_key_config.py gooddata_api_client/model/profile.py gooddata_api_client/model/profile_features.py gooddata_api_client/model/profile_links.py @@ -2935,7 +3050,6 @@ gooddata_api_client/model/provision_database_instance_request.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 -gooddata_api_client/model/random_distribution_config.py gooddata_api_client/model/range.py gooddata_api_client/model/range_condition.py gooddata_api_client/model/range_condition_range.py @@ -2952,45 +3066,32 @@ gooddata_api_client/model/raw_export_request.py gooddata_api_client/model/read_csv_file_manifests_request.py gooddata_api_client/model/read_csv_file_manifests_request_item.py gooddata_api_client/model/read_csv_file_manifests_response.py -gooddata_api_client/model/reasoning.py -gooddata_api_client/model/reasoning_step.py gooddata_api_client/model/reference_identifier.py gooddata_api_client/model/reference_source_column.py -gooddata_api_client/model/refresh_partition_request.py 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_wrapper.py gooddata_api_client/model/remove_database_data_source_response.py +gooddata_api_client/model/report_export_request.py gooddata_api_client/model/resolve_settings_request.py -gooddata_api_client/model/resolved_llm.py -gooddata_api_client/model/resolved_llm_provider.py -gooddata_api_client/model/resolved_llm_provider_all_of.py -gooddata_api_client/model/resolved_llms.py -gooddata_api_client/model/resolved_llms_data.py gooddata_api_client/model/resolved_setting.py gooddata_api_client/model/rest_api_identifier.py +gooddata_api_client/model/restricted_object.py gooddata_api_client/model/result_cache_metadata.py gooddata_api_client/model/result_dimension.py gooddata_api_client/model/result_dimension_header.py gooddata_api_client/model/result_spec.py -gooddata_api_client/model/rich_text_widget_descriptor.py -gooddata_api_client/model/route_result.py gooddata_api_client/model/rsa_specification.py gooddata_api_client/model/rule_permission.py gooddata_api_client/model/run_service_command_request.py gooddata_api_client/model/running_section.py -gooddata_api_client/model/saved_visualization.py gooddata_api_client/model/scan_request.py gooddata_api_client/model/scan_result_pdm.py gooddata_api_client/model/scan_sql_request.py gooddata_api_client/model/scan_sql_response.py gooddata_api_client/model/schedule_cache_retention.py -gooddata_api_client/model/search_relationship_object.py -gooddata_api_client/model/search_request.py -gooddata_api_client/model/search_result.py -gooddata_api_client/model/search_result_object.py gooddata_api_client/model/section_slide_template.py gooddata_api_client/model/service_info.py gooddata_api_client/model/set_certification_request.py @@ -3011,6 +3112,8 @@ gooddata_api_client/model/sort_key_value.py gooddata_api_client/model/sort_key_value_value.py gooddata_api_client/model/source_reference_identifier.py gooddata_api_client/model/sql_column.py +gooddata_api_client/model/sql_flow_input.py +gooddata_api_client/model/sql_flow_input_all_of.py gooddata_api_client/model/sql_query.py gooddata_api_client/model/sql_query_all_of.py gooddata_api_client/model/static_features.py @@ -3020,7 +3123,6 @@ gooddata_api_client/model/string_parameter_allowed_value.py gooddata_api_client/model/string_parameter_definition.py gooddata_api_client/model/succeeded_operation.py gooddata_api_client/model/succeeded_operation_all_of.py -gooddata_api_client/model/suggestion.py gooddata_api_client/model/switch_identity_provider_request.py gooddata_api_client/model/table.py gooddata_api_client/model/table_all_of.py @@ -3045,8 +3147,6 @@ gooddata_api_client/model/test_notification_all_of.py gooddata_api_client/model/test_query_duration.py gooddata_api_client/model/test_request.py gooddata_api_client/model/test_response.py -gooddata_api_client/model/thought.py -gooddata_api_client/model/time_slice_partition_config.py gooddata_api_client/model/total.py gooddata_api_client/model/total_dimension.py gooddata_api_client/model/total_execution_result_header.py @@ -3055,14 +3155,11 @@ gooddata_api_client/model/trending_object_item.py gooddata_api_client/model/trending_objects_result.py gooddata_api_client/model/trigger_automation_request.py gooddata_api_client/model/trigger_quality_issues_calculation_response.py -gooddata_api_client/model/ui_context.py -gooddata_api_client/model/unique_key_config.py gooddata_api_client/model/update_database_data_source_request.py gooddata_api_client/model/update_database_data_source_response.py gooddata_api_client/model/upload_file_response.py gooddata_api_client/model/upload_geo_collection_file_response.py gooddata_api_client/model/user_assignee.py -gooddata_api_client/model/user_context.py gooddata_api_client/model/user_group_assignee.py gooddata_api_client/model/user_group_identifier.py gooddata_api_client/model/user_group_permission.py @@ -3081,23 +3178,18 @@ gooddata_api_client/model/validity_period_cache_retention.py gooddata_api_client/model/value.py gooddata_api_client/model/visible_filter.py gooddata_api_client/model/visual_export_request.py -gooddata_api_client/model/visualization_config.py gooddata_api_client/model/visualization_object_execution.py -gooddata_api_client/model/visualization_switcher_widget_descriptor.py +gooddata_api_client/model/visualization_permissions.py +gooddata_api_client/model/visualization_permissions_assignment.py +gooddata_api_client/model/visualization_permissions_for_assignee.py +gooddata_api_client/model/visualization_permissions_for_assignee_rule.py gooddata_api_client/model/webhook.py gooddata_api_client/model/webhook_all_of.py gooddata_api_client/model/webhook_automation_info.py gooddata_api_client/model/webhook_message.py gooddata_api_client/model/webhook_message_data.py gooddata_api_client/model/webhook_recipient.py -gooddata_api_client/model/what_if_measure_adjustment_config.py -gooddata_api_client/model/what_if_scenario_config.py -gooddata_api_client/model/what_if_scenario_item.py -gooddata_api_client/model/widget_descriptor.py gooddata_api_client/model/widget_slides_template.py -gooddata_api_client/model/workflow_dashboard_summary_request_dto.py -gooddata_api_client/model/workflow_dashboard_summary_response_dto.py -gooddata_api_client/model/workflow_status_response_dto.py gooddata_api_client/model/workspace_automation_identifier.py gooddata_api_client/model/workspace_automation_management_bulk_request.py gooddata_api_client/model/workspace_cache_settings.py diff --git a/gooddata-api-client/README.md b/gooddata-api-client/README.md index 19e147380..c765d4c7c 100644 --- a/gooddata-api-client/README.md +++ b/gooddata-api-client/README.md @@ -49,22 +49,22 @@ Please follow the [installation procedure](#installation--usage) and then run th import time import gooddata_api_client from pprint import pprint -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.entity_search_body import EntitySearchBody -from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList -from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument -from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList -from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument -from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument -from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument -from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList -from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument +from gooddata_api_client.api import ai_lake_api +from gooddata_api_client.model.add_database_data_source_request import AddDatabaseDataSourceRequest +from gooddata_api_client.model.add_database_data_source_response import AddDatabaseDataSourceResponse +from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest +from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response +from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse +from gooddata_api_client.model.json_api_document_database_instance import JsonApiDocumentDatabaseInstance +from gooddata_api_client.model.json_api_list_document_data_source_info import JsonApiListDocumentDataSourceInfo +from gooddata_api_client.model.json_api_list_document_database_instance import JsonApiListDocumentDatabaseInstance +from gooddata_api_client.model.json_api_list_document_object_storage_info import JsonApiListDocumentObjectStorageInfo +from gooddata_api_client.model.json_api_list_document_service_info import JsonApiListDocumentServiceInfo +from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest +from gooddata_api_client.model.remove_database_data_source_response import RemoveDatabaseDataSourceResponse +from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest +from gooddata_api_client.model.update_database_data_source_request import UpdateDatabaseDataSourceRequest +from gooddata_api_client.model.update_database_data_source_response import UpdateDatabaseDataSourceResponse # 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( @@ -76,56 +76,19 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_knowledge_recommendation_post_optional_id_document = JsonApiKnowledgeRecommendationPostOptionalIdDocument( - data=JsonApiKnowledgeRecommendationPostOptionalId( - attributes=JsonApiKnowledgeRecommendationInAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, - are_relations_valid=True, - comparison_type="MONTH", - confidence=None, - description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, - tags=[ - "tags_example", - ], - title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", - ), - id="id1", - relationships=JsonApiKnowledgeRecommendationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", - ), - ) # JsonApiKnowledgeRecommendationPostOptionalIdDocument | - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) + api_instance = ai_lake_api.AILakeApi(api_client) + instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. + add_database_data_source_request = AddDatabaseDataSourceRequest( + data_source_id="data_source_id_example", + data_source_name="data_source_name_example", + ) # AddDatabaseDataSourceRequest | try: - # Post Knowledge Recommendations - api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, include=include, meta_include=meta_include) + # (BETA) Add a data source to an AILake Database instance + api_response = api_instance.add_ai_lake_database_data_source(instance_id, add_database_data_source_request) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->create_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling AILakeApi->add_ai_lake_database_data_source: %s\n" % e) ``` ## Documentation for API Endpoints @@ -134,52 +97,22 @@ All URIs are relative to *http://localhost* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- -*AIApi* | [**create_entity_knowledge_recommendations**](docs/AIApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Post Knowledge Recommendations -*AIApi* | [**create_entity_memory_items**](docs/AIApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items -*AIApi* | [**create_entity_org_memory_items**](docs/AIApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities -*AIApi* | [**delete_entity_knowledge_recommendations**](docs/AIApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Delete a Knowledge Recommendation -*AIApi* | [**delete_entity_memory_items**](docs/AIApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item -*AIApi* | [**delete_entity_org_memory_items**](docs/AIApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity -*AIApi* | [**get_all_entities_knowledge_recommendations**](docs/AIApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations -*AIApi* | [**get_all_entities_memory_items**](docs/AIApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items -*AIApi* | [**get_all_entities_org_memory_items**](docs/AIApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities -*AIApi* | [**get_entity_knowledge_recommendations**](docs/AIApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation -*AIApi* | [**get_entity_memory_items**](docs/AIApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item -*AIApi* | [**get_entity_org_memory_items**](docs/AIApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity -*AIApi* | [**patch_entity_knowledge_recommendations**](docs/AIApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -*AIApi* | [**patch_entity_memory_items**](docs/AIApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item -*AIApi* | [**patch_entity_org_memory_items**](docs/AIApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity -*AIApi* | [**search_entities_knowledge_recommendations**](docs/AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) -*AIApi* | [**search_entities_memory_items**](docs/AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) -*AIApi* | [**update_entity_knowledge_recommendations**](docs/AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation -*AIApi* | [**update_entity_memory_items**](docs/AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item -*AIApi* | [**update_entity_org_memory_items**](docs/AIApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity -*AIAgentsApi* | [**create_entity_agents**](docs/AIAgentsApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities -*AIAgentsApi* | [**delete_entity_agents**](docs/AIAgentsApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity -*AIAgentsApi* | [**get_all_entities_agents**](docs/AIAgentsApi.md#get_all_entities_agents) | **GET** /api/v1/entities/agents | Get all Agent entities -*AIAgentsApi* | [**get_entity_agents**](docs/AIAgentsApi.md#get_entity_agents) | **GET** /api/v1/entities/agents/{id} | Get Agent entity -*AIAgentsApi* | [**patch_entity_agents**](docs/AIAgentsApi.md#patch_entity_agents) | **PATCH** /api/v1/entities/agents/{id} | Patch Agent entity -*AIAgentsApi* | [**update_entity_agents**](docs/AIAgentsApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity *AILakeApi* | [**add_ai_lake_database_data_source**](docs/AILakeApi.md#add_ai_lake_database_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) Add a data source to an AILake Database instance *AILakeApi* | [**analyze_statistics**](docs/AILakeApi.md#analyze_statistics) | **POST** /api/v1/ailake/database/instances/{instanceId}/analyzeStatistics | (BETA) Run ANALYZE TABLE for tables in a database instance -*AILakeApi* | [**create_ai_lake_pipe_table**](docs/AILakeApi.md#create_ai_lake_pipe_table) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) Create a new AI Lake pipe table -*AILakeApi* | [**delete_ai_lake_pipe_table**](docs/AILakeApi.md#delete_ai_lake_pipe_table) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Delete an AI Lake pipe table *AILakeApi* | [**deprovision_ai_lake_database_instance**](docs/AILakeApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance *AILakeApi* | [**get_ai_lake_database_instance**](docs/AILakeApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance *AILakeApi* | [**get_ai_lake_operation**](docs/AILakeApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details -*AILakeApi* | [**get_ai_lake_pipe_table**](docs/AILakeApi.md#get_ai_lake_pipe_table) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Get an AI Lake pipe table *AILakeApi* | [**get_ai_lake_service_status**](docs/AILakeApi.md#get_ai_lake_service_status) | **GET** /api/v1/ailake/services/{serviceId}/status | (BETA) Get AI Lake service status *AILakeApi* | [**list_ai_lake_database_data_sources**](docs/AILakeApi.md#list_ai_lake_database_data_sources) | **GET** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) List data sources of an AILake Database instance *AILakeApi* | [**list_ai_lake_database_instances**](docs/AILakeApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances *AILakeApi* | [**list_ai_lake_object_storages**](docs/AILakeApi.md#list_ai_lake_object_storages) | **GET** /api/v1/ailake/objectStorages | (BETA) List registered AI Lake ObjectStorages -*AILakeApi* | [**list_ai_lake_pipe_tables**](docs/AILakeApi.md#list_ai_lake_pipe_tables) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) List AI Lake pipe tables *AILakeApi* | [**list_ai_lake_services**](docs/AILakeApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services *AILakeApi* | [**provision_ai_lake_database_instance**](docs/AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance -*AILakeApi* | [**refresh_ai_lake_pipe_table_partition**](docs/AILakeApi.md#refresh_ai_lake_pipe_table_partition) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh | (BETA) Refresh a pipe table partition *AILakeApi* | [**remove_ai_lake_database_data_source**](docs/AILakeApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance *AILakeApi* | [**run_ai_lake_service_command**](docs/AILakeApi.md#run_ai_lake_service_command) | **POST** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command *AILakeApi* | [**update_ai_lake_database_data_source**](docs/AILakeApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance *AILakeDatabasesApi* | [**add_ai_lake_database_data_source**](docs/AILakeDatabasesApi.md#add_ai_lake_database_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) Add a data source to an AILake Database instance +*AILakeDatabasesApi* | [**analyze_statistics**](docs/AILakeDatabasesApi.md#analyze_statistics) | **POST** /api/v1/ailake/database/instances/{instanceId}/analyzeStatistics | (BETA) Run ANALYZE TABLE for tables in a database instance *AILakeDatabasesApi* | [**deprovision_ai_lake_database_instance**](docs/AILakeDatabasesApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance *AILakeDatabasesApi* | [**get_ai_lake_database_instance**](docs/AILakeDatabasesApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance *AILakeDatabasesApi* | [**list_ai_lake_database_data_sources**](docs/AILakeDatabasesApi.md#list_ai_lake_database_data_sources) | **GET** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) List data sources of an AILake Database instance @@ -188,21 +121,20 @@ Class | Method | HTTP request | Description *AILakeDatabasesApi* | [**provision_ai_lake_database_instance**](docs/AILakeDatabasesApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance *AILakeDatabasesApi* | [**remove_ai_lake_database_data_source**](docs/AILakeDatabasesApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance *AILakeDatabasesApi* | [**update_ai_lake_database_data_source**](docs/AILakeDatabasesApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance -*AILakePipeTablesApi* | [**analyze_statistics**](docs/AILakePipeTablesApi.md#analyze_statistics) | **POST** /api/v1/ailake/database/instances/{instanceId}/analyzeStatistics | (BETA) Run ANALYZE TABLE for tables in a database instance -*AILakePipeTablesApi* | [**create_ai_lake_pipe_table**](docs/AILakePipeTablesApi.md#create_ai_lake_pipe_table) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) Create a new AI Lake pipe table -*AILakePipeTablesApi* | [**delete_ai_lake_pipe_table**](docs/AILakePipeTablesApi.md#delete_ai_lake_pipe_table) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Delete an AI Lake pipe table -*AILakePipeTablesApi* | [**get_ai_lake_pipe_table**](docs/AILakePipeTablesApi.md#get_ai_lake_pipe_table) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Get an AI Lake pipe table -*AILakePipeTablesApi* | [**list_ai_lake_pipe_tables**](docs/AILakePipeTablesApi.md#list_ai_lake_pipe_tables) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) List AI Lake pipe tables -*AILakePipeTablesApi* | [**refresh_ai_lake_pipe_table_partition**](docs/AILakePipeTablesApi.md#refresh_ai_lake_pipe_table_partition) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh | (BETA) Refresh a pipe table partition *AILakeServicesOperationsApi* | [**get_ai_lake_operation**](docs/AILakeServicesOperationsApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details *AILakeServicesOperationsApi* | [**get_ai_lake_service_status**](docs/AILakeServicesOperationsApi.md#get_ai_lake_service_status) | **GET** /api/v1/ailake/services/{serviceId}/status | (BETA) Get AI Lake service status *AILakeServicesOperationsApi* | [**list_ai_lake_services**](docs/AILakeServicesOperationsApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services *AILakeServicesOperationsApi* | [**run_ai_lake_service_command**](docs/AILakeServicesOperationsApi.md#run_ai_lake_service_command) | **POST** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command -*AIObservabilityApi* | [**reload_observability_layout**](docs/AIObservabilityApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout *APITokensApi* | [**create_entity_api_tokens**](docs/APITokensApi.md#create_entity_api_tokens) | **POST** /api/v1/entities/users/{userId}/apiTokens | Post a new API token for the user *APITokensApi* | [**delete_entity_api_tokens**](docs/APITokensApi.md#delete_entity_api_tokens) | **DELETE** /api/v1/entities/users/{userId}/apiTokens/{id} | Delete an API Token for a user *APITokensApi* | [**get_all_entities_api_tokens**](docs/APITokensApi.md#get_all_entities_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens | List all api tokens for a user *APITokensApi* | [**get_entity_api_tokens**](docs/APITokensApi.md#get_entity_api_tokens) | **GET** /api/v1/entities/users/{userId}/apiTokens/{id} | Get an API Token for a user +*AgentsApi* | [**create_entity_agents**](docs/AgentsApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities +*AgentsApi* | [**delete_entity_agents**](docs/AgentsApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity +*AgentsApi* | [**get_all_entities_agents**](docs/AgentsApi.md#get_all_entities_agents) | **GET** /api/v1/entities/agents | Get all Agent entities +*AgentsApi* | [**get_entity_agents**](docs/AgentsApi.md#get_entity_agents) | **GET** /api/v1/entities/agents/{id} | Get Agent entity +*AgentsApi* | [**patch_entity_agents**](docs/AgentsApi.md#patch_entity_agents) | **PATCH** /api/v1/entities/agents/{id} | Patch Agent entity +*AgentsApi* | [**update_entity_agents**](docs/AgentsApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity *AnalyticsModelApi* | [**get_analytics_model**](docs/AnalyticsModelApi.md#get_analytics_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Get analytics model *AnalyticsModelApi* | [**set_analytics_model**](docs/AnalyticsModelApi.md#set_analytics_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/analyticsModel | Set analytics model *AppearanceApi* | [**create_entity_color_palettes**](docs/AppearanceApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes @@ -290,6 +222,13 @@ Class | Method | HTTP request | Description *ComputationApi* | [**retrieve_execution_metadata**](docs/ComputationApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata. *ComputationApi* | [**retrieve_result**](docs/ComputationApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result *ComputationApi* | [**retrieve_result_binary**](docs/ComputationApi.md#retrieve_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary | (BETA) Get a single execution result in Apache Arrow File or Stream format +*ComputedAttributesApi* | [**create_entity_computed_attributes**](docs/ComputedAttributesApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes +*ComputedAttributesApi* | [**delete_entity_computed_attributes**](docs/ComputedAttributesApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute +*ComputedAttributesApi* | [**get_all_entities_computed_attributes**](docs/ComputedAttributesApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes +*ComputedAttributesApi* | [**get_entity_computed_attributes**](docs/ComputedAttributesApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute +*ComputedAttributesApi* | [**patch_entity_computed_attributes**](docs/ComputedAttributesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute +*ComputedAttributesApi* | [**search_entities_computed_attributes**](docs/ComputedAttributesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +*ComputedAttributesApi* | [**update_entity_computed_attributes**](docs/ComputedAttributesApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute *CookieSecurityConfigurationApi* | [**get_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration *CookieSecurityConfigurationApi* | [**patch_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration *CookieSecurityConfigurationApi* | [**update_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration @@ -336,7 +275,7 @@ Class | Method | HTTP request | Description *DataSourceStatisticsApi* | [**delete_data_source_statistics**](docs/DataSourceStatisticsApi.md#delete_data_source_statistics) | **DELETE** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Delete stored physical statistics for a data source *DataSourceStatisticsApi* | [**get_data_source_statistics**](docs/DataSourceStatisticsApi.md#get_data_source_statistics) | **GET** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Retrieve stored physical statistics for a data source *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 StarRocks 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 *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 @@ -397,6 +336,12 @@ Class | Method | HTTP request | Description *FilterViewsApi* | [**update_entity_filter_views**](docs/FilterViewsApi.md#update_entity_filter_views) | **PUT** /api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId} | Put Filter views *FiscalCalendarsApi* | [**get_all_entities_fiscal_calendars**](docs/FiscalCalendarsApi.md#get_all_entities_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars | Get all Fiscal Calendars *FiscalCalendarsApi* | [**get_entity_fiscal_calendars**](docs/FiscalCalendarsApi.md#get_entity_fiscal_calendars) | **GET** /api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId} | Get a Fiscal Calendar +*FlowApi* | [**cancel_flows**](docs/FlowApi.md#cancel_flows) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel | (EXPERIMENTAL) Apply the given cancel tokens to flows +*FlowApi* | [**execute_flow**](docs/FlowApi.md#execute_flow) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow | (EXPERIMENTAL) Execute a flow +*FlowApi* | [**list_flow_operations**](docs/FlowApi.md#list_flow_operations) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/operations | (EXPERIMENTAL) List the operations of flows +*FlowApi* | [**retrieve_flow_result_binary**](docs/FlowApi.md#retrieve_flow_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary | (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format +*FlowApi* | [**retrieve_flow_result_metadata**](docs/FlowApi.md#retrieve_flow_result_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata | (EXPERIMENTAL) Get the metadata of a flow result +*FlowApi* | [**retrieve_flow_result_table**](docs/FlowApi.md#retrieve_flow_result_table) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table | (EXPERIMENTAL) Get a page of a flow result *GenerateLogicalDataModelApi* | [**generate_logical_model**](docs/GenerateLogicalDataModelApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) *GeographicDataApi* | [**create_entity_custom_geo_collections**](docs/GeographicDataApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections *GeographicDataApi* | [**delete_entity_custom_geo_collections**](docs/GeographicDataApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection @@ -428,6 +373,13 @@ Class | Method | HTTP request | Description *JWKSApi* | [**get_entity_jwks**](docs/JWKSApi.md#get_entity_jwks) | **GET** /api/v1/entities/jwks/{id} | Get Jwk *JWKSApi* | [**patch_entity_jwks**](docs/JWKSApi.md#patch_entity_jwks) | **PATCH** /api/v1/entities/jwks/{id} | Patch Jwk *JWKSApi* | [**update_entity_jwks**](docs/JWKSApi.md#update_entity_jwks) | **PUT** /api/v1/entities/jwks/{id} | Put Jwk +*KnowledgeRecommendationsApi* | [**create_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Post Knowledge Recommendations +*KnowledgeRecommendationsApi* | [**delete_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Delete a Knowledge Recommendation +*KnowledgeRecommendationsApi* | [**get_all_entities_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations +*KnowledgeRecommendationsApi* | [**get_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation +*KnowledgeRecommendationsApi* | [**patch_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation +*KnowledgeRecommendationsApi* | [**search_entities_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +*KnowledgeRecommendationsApi* | [**update_entity_knowledge_recommendations**](docs/KnowledgeRecommendationsApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation *LDMDeclarativeAPIsApi* | [**get_logical_model**](docs/LDMDeclarativeAPIsApi.md#get_logical_model) | **GET** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Get logical model *LDMDeclarativeAPIsApi* | [**set_logical_model**](docs/LDMDeclarativeAPIsApi.md#set_logical_model) | **PUT** /api/v1/layout/workspaces/{workspaceId}/logicalModel | Set logical model *LLMEndpointsApi* | [**create_entity**](docs/LLMEndpointsApi.md#create_entity) | **POST** /api/v1/entities/llmEndpoints | Post LLM endpoint entities (Removed) @@ -449,6 +401,20 @@ Class | Method | HTTP request | Description *ManagePermissionsApi* | [**get_data_source_permissions**](docs/ManagePermissionsApi.md#get_data_source_permissions) | **GET** /api/v1/layout/dataSources/{dataSourceId}/permissions | Get permissions for the data source *ManagePermissionsApi* | [**manage_data_source_permissions**](docs/ManagePermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *ManagePermissionsApi* | [**set_data_source_permissions**](docs/ManagePermissionsApi.md#set_data_source_permissions) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/permissions | Set data source permissions. +*MemoryItemsApi* | [**create_entity_memory_items**](docs/MemoryItemsApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items +*MemoryItemsApi* | [**create_entity_org_memory_items**](docs/MemoryItemsApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities +*MemoryItemsApi* | [**delete_entity_memory_items**](docs/MemoryItemsApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item +*MemoryItemsApi* | [**delete_entity_org_memory_items**](docs/MemoryItemsApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity +*MemoryItemsApi* | [**get_all_entities_memory_items**](docs/MemoryItemsApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items +*MemoryItemsApi* | [**get_all_entities_org_memory_items**](docs/MemoryItemsApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities +*MemoryItemsApi* | [**get_entity_memory_items**](docs/MemoryItemsApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item +*MemoryItemsApi* | [**get_entity_org_memory_items**](docs/MemoryItemsApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity +*MemoryItemsApi* | [**patch_entity_memory_items**](docs/MemoryItemsApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item +*MemoryItemsApi* | [**patch_entity_org_memory_items**](docs/MemoryItemsApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity +*MemoryItemsApi* | [**search_entities_memory_items**](docs/MemoryItemsApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) +*MemoryItemsApi* | [**update_entity_memory_items**](docs/MemoryItemsApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item +*MemoryItemsApi* | [**update_entity_org_memory_items**](docs/MemoryItemsApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity +*MetadataSynchronizationApi* | [**sync_metadata**](docs/MetadataSynchronizationApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization *MetricsApi* | [**create_entity_metrics**](docs/MetricsApi.md#create_entity_metrics) | **POST** /api/v1/entities/workspaces/{workspaceId}/metrics | Post Metrics *MetricsApi* | [**delete_entity_metrics**](docs/MetricsApi.md#delete_entity_metrics) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/metrics/{objectId} | Delete a Metric *MetricsApi* | [**get_all_entities_metrics**](docs/MetricsApi.md#get_all_entities_metrics) | **GET** /api/v1/entities/workspaces/{workspaceId}/metrics | Get all Metrics @@ -475,6 +441,7 @@ Class | Method | HTTP request | Description *NotificationChannelsApi* | [**update_entity_notification_channels**](docs/NotificationChannelsApi.md#update_entity_notification_channels) | **PUT** /api/v1/entities/notificationChannels/{id} | Put Notification Channel entity *OGCAPIFeaturesApi* | [**get_collection_items**](docs/OGCAPIFeaturesApi.md#get_collection_items) | **GET** /api/v1/location/collections/{collectionId}/items | Get collection features *OGCAPIFeaturesApi* | [**get_custom_collection_items**](docs/OGCAPIFeaturesApi.md#get_custom_collection_items) | **GET** /api/v1/location/custom/collections/{collectionId}/items | Get custom collection features +*ObservabilityApi* | [**reload_observability_layout**](docs/ObservabilityApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout *OptionsApi* | [**get_all_options**](docs/OptionsApi.md#get_all_options) | **GET** /api/v1/options | Links for all configuration options *OrganizationDeclarativeAPIsApi* | [**get_agents_layout**](docs/OrganizationDeclarativeAPIsApi.md#get_agents_layout) | **GET** /api/v1/layout/agents | Get all AI agent configurations layout *OrganizationDeclarativeAPIsApi* | [**get_custom_geo_collections_layout**](docs/OrganizationDeclarativeAPIsApi.md#get_custom_geo_collections_layout) | **GET** /api/v1/layout/customGeoCollections | Get all custom geo collections layout @@ -508,6 +475,7 @@ Class | Method | HTTP request | Description *ParametersApi* | [**update_entity_parameters**](docs/ParametersApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter *PermissionsApi* | [**attribute_permissions**](docs/PermissionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions *PermissionsApi* | [**available_assignees**](docs/PermissionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees +*PermissionsApi* | [**computed_attribute_permissions**](docs/PermissionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions *PermissionsApi* | [**dashboard_permissions**](docs/PermissionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions *PermissionsApi* | [**fact_permissions**](docs/PermissionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions *PermissionsApi* | [**get_organization_permissions**](docs/PermissionsApi.md#get_organization_permissions) | **GET** /api/v1/layout/organization/permissions | Get organization permissions @@ -516,18 +484,21 @@ Class | Method | HTTP request | Description *PermissionsApi* | [**get_workspace_permissions**](docs/PermissionsApi.md#get_workspace_permissions) | **GET** /api/v1/layout/workspaces/{workspaceId}/permissions | Get permissions for the workspace *PermissionsApi* | [**label_permissions**](docs/PermissionsApi.md#label_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions | Get Label Permissions *PermissionsApi* | [**manage_attribute_permissions**](docs/PermissionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute +*PermissionsApi* | [**manage_computed_attribute_permissions**](docs/PermissionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute *PermissionsApi* | [**manage_dashboard_permissions**](docs/PermissionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard *PermissionsApi* | [**manage_data_source_permissions**](docs/PermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *PermissionsApi* | [**manage_fact_permissions**](docs/PermissionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact *PermissionsApi* | [**manage_label_permissions**](docs/PermissionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label *PermissionsApi* | [**manage_metric_permissions**](docs/PermissionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric *PermissionsApi* | [**manage_organization_permissions**](docs/PermissionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization +*PermissionsApi* | [**manage_visualization_permissions**](docs/PermissionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization *PermissionsApi* | [**manage_workspace_permissions**](docs/PermissionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace *PermissionsApi* | [**metric_permissions**](docs/PermissionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions *PermissionsApi* | [**set_organization_permissions**](docs/PermissionsApi.md#set_organization_permissions) | **PUT** /api/v1/layout/organization/permissions | Set organization permissions *PermissionsApi* | [**set_user_group_permissions**](docs/PermissionsApi.md#set_user_group_permissions) | **PUT** /api/v1/layout/userGroups/{userGroupId}/permissions | Set permissions for the user-group *PermissionsApi* | [**set_user_permissions**](docs/PermissionsApi.md#set_user_permissions) | **PUT** /api/v1/layout/users/{userId}/permissions | Set permissions for the user *PermissionsApi* | [**set_workspace_permissions**](docs/PermissionsApi.md#set_workspace_permissions) | **PUT** /api/v1/layout/workspaces/{workspaceId}/permissions | Set permissions for the workspace +*PermissionsApi* | [**visualization_permissions**](docs/PermissionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions *PluginsApi* | [**create_entity_dashboard_plugins**](docs/PluginsApi.md#create_entity_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Post Plugins *PluginsApi* | [**delete_entity_dashboard_plugins**](docs/PluginsApi.md#delete_entity_dashboard_plugins) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Delete a Plugin *PluginsApi* | [**get_all_entities_dashboard_plugins**](docs/PluginsApi.md#get_all_entities_dashboard_plugins) | **GET** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins | Get all Plugins @@ -537,19 +508,39 @@ Class | Method | HTTP request | Description *PluginsApi* | [**update_entity_dashboard_plugins**](docs/PluginsApi.md#update_entity_dashboard_plugins) | **PUT** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId} | Put a Plugin *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_report_export**](docs/ReportExportApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request +*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. *ReportingSettingsApi* | [**resolve_settings_without_workspace**](docs/ReportingSettingsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace. +*ReportsApi* | [**create_entity_report_page_layouts**](docs/ReportsApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout +*ReportsApi* | [**create_entity_report_templates**](docs/ReportsApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template +*ReportsApi* | [**create_entity_reports**](docs/ReportsApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report +*ReportsApi* | [**delete_entity_report_page_layouts**](docs/ReportsApi.md#delete_entity_report_page_layouts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Delete a Report Page Layout +*ReportsApi* | [**delete_entity_report_templates**](docs/ReportsApi.md#delete_entity_report_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Delete a Report Template +*ReportsApi* | [**delete_entity_reports**](docs/ReportsApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report +*ReportsApi* | [**get_all_entities_report_page_layouts**](docs/ReportsApi.md#get_all_entities_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Get all Report Page Layouts +*ReportsApi* | [**get_all_entities_report_templates**](docs/ReportsApi.md#get_all_entities_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Get all Report Templates +*ReportsApi* | [**get_all_entities_reports**](docs/ReportsApi.md#get_all_entities_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports | Get all Reports +*ReportsApi* | [**get_entity_report_page_layouts**](docs/ReportsApi.md#get_entity_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Get a Report Page Layout +*ReportsApi* | [**get_entity_report_templates**](docs/ReportsApi.md#get_entity_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Get a Report Template +*ReportsApi* | [**get_entity_reports**](docs/ReportsApi.md#get_entity_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Get a Report +*ReportsApi* | [**patch_entity_report_page_layouts**](docs/ReportsApi.md#patch_entity_report_page_layouts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Patch a Report Page Layout +*ReportsApi* | [**patch_entity_report_templates**](docs/ReportsApi.md#patch_entity_report_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Patch a Report Template +*ReportsApi* | [**patch_entity_reports**](docs/ReportsApi.md#patch_entity_reports) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Patch a Report +*ReportsApi* | [**update_entity_report_page_layouts**](docs/ReportsApi.md#update_entity_report_page_layouts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Put a Report Page Layout +*ReportsApi* | [**update_entity_report_templates**](docs/ReportsApi.md#update_entity_report_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Put a Report Template +*ReportsApi* | [**update_entity_reports**](docs/ReportsApi.md#update_entity_reports) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Put a Report *ScanningApi* | [**get_data_source_schemata**](docs/ScanningApi.md#get_data_source_schemata) | **GET** /api/v1/actions/dataSources/{dataSourceId}/scanSchemata | Get a list of schema names of a database *ScanningApi* | [**scan_data_source**](docs/ScanningApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM) *ScanningApi* | [**scan_sql**](docs/ScanningApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query *SlidesExportApi* | [**create_slides_export**](docs/SlidesExportApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request *SlidesExportApi* | [**get_slides_export**](docs/SlidesExportApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files *SlidesExportApi* | [**get_slides_export_metadata**](docs/SlidesExportApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context -*SmartFunctionsApi* | [**ai_chat**](docs/SmartFunctionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (BETA) Chat with AI -*SmartFunctionsApi* | [**ai_chat_history**](docs/SmartFunctionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (BETA) Get Chat History -*SmartFunctionsApi* | [**ai_chat_stream**](docs/SmartFunctionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (BETA) Chat with AI -*SmartFunctionsApi* | [**ai_chat_usage**](docs/SmartFunctionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | Get Chat Usage -*SmartFunctionsApi* | [**ai_search**](docs/SmartFunctionsApi.md#ai_search) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/search | (BETA) Semantic Search in Metadata +*SmartFunctionsApi* | [**ai_chat**](docs/SmartFunctionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (REMOVED) Chat with AI +*SmartFunctionsApi* | [**ai_chat_history**](docs/SmartFunctionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (REMOVED) Get Chat History +*SmartFunctionsApi* | [**ai_chat_stream**](docs/SmartFunctionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (REMOVED) Chat with AI +*SmartFunctionsApi* | [**ai_chat_usage**](docs/SmartFunctionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | (REMOVED) Get Chat Usage *SmartFunctionsApi* | [**anomaly_detection**](docs/SmartFunctionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection *SmartFunctionsApi* | [**anomaly_detection_result**](docs/SmartFunctionsApi.md#anomaly_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result *SmartFunctionsApi* | [**clustering**](docs/SmartFunctionsApi.md#clustering) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering @@ -565,7 +556,6 @@ Class | Method | HTTP request | Description *SmartFunctionsApi* | [**list_llm_provider_models_by_id**](docs/SmartFunctionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id *SmartFunctionsApi* | [**memory_created_by_users**](docs/SmartFunctionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users *SmartFunctionsApi* | [**resolve_llm_endpoints**](docs/SmartFunctionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace (Removed) -*SmartFunctionsApi* | [**resolve_llm_providers**](docs/SmartFunctionsApi.md#resolve_llm_providers) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders | Get Active LLM configuration for this workspace *SmartFunctionsApi* | [**tags**](docs/SmartFunctionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags *SmartFunctionsApi* | [**test_llm_provider**](docs/SmartFunctionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider *SmartFunctionsApi* | [**test_llm_provider_by_id**](docs/SmartFunctionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id @@ -595,6 +585,7 @@ Class | Method | HTTP request | Description *UserGroupsEntityAPIsApi* | [**patch_entity_user_groups**](docs/UserGroupsEntityAPIsApi.md#patch_entity_user_groups) | **PATCH** /api/v1/entities/userGroups/{id} | Patch UserGroup entity *UserGroupsEntityAPIsApi* | [**update_entity_user_groups**](docs/UserGroupsEntityAPIsApi.md#update_entity_user_groups) | **PUT** /api/v1/entities/userGroups/{id} | Put UserGroup entity *UserAuthorizationApi* | [**get_profile**](docs/UserAuthorizationApi.md#get_profile) | **GET** /api/v1/profile | Get Profile +*UserAuthorizationApi* | [**process_invitation**](docs/UserAuthorizationApi.md#process_invitation) | **POST** /api/v1/actions/invite | Invite User *UserDataFiltersApi* | [**get_user_data_filters**](docs/UserDataFiltersApi.md#get_user_data_filters) | **GET** /api/v1/layout/workspaces/{workspaceId}/userDataFilters | Get user data filters *UserDataFiltersApi* | [**set_user_data_filters**](docs/UserDataFiltersApi.md#set_user_data_filters) | **PUT** /api/v1/layout/workspaces/{workspaceId}/userDataFilters | Set user data filters *UserIdentifiersApi* | [**get_all_entities_user_identifiers**](docs/UserIdentifiersApi.md#get_all_entities_user_identifiers) | **GET** /api/v1/entities/userIdentifiers | Get UserIdentifier entities @@ -668,11 +659,10 @@ Class | Method | HTTP request | Description *WorkspacesSettingsApi* | [**workspace_resolve_all_settings**](docs/WorkspacesSettingsApi.md#workspace_resolve_all_settings) | **GET** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for all settings. *WorkspacesSettingsApi* | [**workspace_resolve_settings**](docs/WorkspacesSettingsApi.md#workspace_resolve_settings) | **POST** /api/v1/actions/workspaces/{workspaceId}/resolveSettings | Values for selected settings. *ActionsApi* | [**add_targets**](docs/ActionsApi.md#add_targets) | **POST** /api/v1/actions/ipAllowlistPolicies/{id}/addTargets | Add targets to IP allowlist policy -*ActionsApi* | [**ai_chat**](docs/ActionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (BETA) Chat with AI -*ActionsApi* | [**ai_chat_history**](docs/ActionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (BETA) Get Chat History -*ActionsApi* | [**ai_chat_stream**](docs/ActionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (BETA) Chat with AI -*ActionsApi* | [**ai_chat_usage**](docs/ActionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | Get Chat Usage -*ActionsApi* | [**ai_search**](docs/ActionsApi.md#ai_search) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/search | (BETA) Semantic Search in Metadata +*ActionsApi* | [**ai_chat**](docs/ActionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (REMOVED) Chat with AI +*ActionsApi* | [**ai_chat_history**](docs/ActionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (REMOVED) Get Chat History +*ActionsApi* | [**ai_chat_stream**](docs/ActionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (REMOVED) Chat with AI +*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* | [**anomaly_detection**](docs/ActionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection @@ -680,7 +670,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**attribute_permissions**](docs/ActionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions *ActionsApi* | [**available_assignees**](docs/ActionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees *ActionsApi* | [**cancel_executions**](docs/ActionsApi.md#cancel_executions) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel | Applies all the given cancel tokens. -*ActionsApi* | [**cancel_workflow**](docs/ActionsApi.md#cancel_workflow) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/cancel | +*ActionsApi* | [**cancel_flows**](docs/ActionsApi.md#cancel_flows) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel | (EXPERIMENTAL) Apply the given cancel tokens to flows *ActionsApi* | [**change_analysis**](docs/ActionsApi.md#change_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis | Compute change analysis *ActionsApi* | [**change_analysis_result**](docs/ActionsApi.md#change_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId} | Get change analysis result *ActionsApi* | [**check_entity_overrides**](docs/ActionsApi.md#check_entity_overrides) | **POST** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. @@ -694,11 +684,13 @@ Class | Method | HTTP request | Description *ActionsApi* | [**compute_report_for_visualization_object**](docs/ActionsApi.md#compute_report_for_visualization_object) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute | (BETA) Executes a visualization object and returns link to the result *ActionsApi* | [**compute_valid_descendants**](docs/ActionsApi.md#compute_valid_descendants) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants | (BETA) Valid descendants *ActionsApi* | [**compute_valid_objects**](docs/ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects +*ActionsApi* | [**computed_attribute_permissions**](docs/ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions *ActionsApi* | [**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_image_export**](docs/ActionsApi.md#create_image_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request *ActionsApi* | [**create_pdf_export**](docs/ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request *ActionsApi* | [**create_raw_export**](docs/ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request +*ActionsApi* | [**create_report_export**](docs/ActionsApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request *ActionsApi* | [**create_slides_export**](docs/ActionsApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request *ActionsApi* | [**create_tabular_export**](docs/ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request *ActionsApi* | [**created_by**](docs/ActionsApi.md#created_by) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users @@ -707,11 +699,11 @@ Class | Method | HTTP request | Description *ActionsApi* | [**delete_files**](docs/ActionsApi.md#delete_files) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/deleteFiles | Delete datasource files *ActionsApi* | [**delete_organization_automations**](docs/ActionsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces *ActionsApi* | [**delete_workspace_automations**](docs/ActionsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace +*ActionsApi* | [**execute_flow**](docs/ActionsApi.md#execute_flow) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow | (EXPERIMENTAL) Execute a flow *ActionsApi* | [**explain_afm**](docs/ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. *ActionsApi* | [**fact_permissions**](docs/ActionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions *ActionsApi* | [**forecast**](docs/ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | Smart functions - Forecast *ActionsApi* | [**forecast_result**](docs/ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | Smart functions - Forecast Result -*ActionsApi* | [**generate_dashboard_summary**](docs/ActionsApi.md#generate_dashboard_summary) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary | *ActionsApi* | [**generate_description**](docs/ActionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object *ActionsApi* | [**generate_logical_model**](docs/ActionsApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) *ActionsApi* | [**generate_title**](docs/ActionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object @@ -726,11 +718,12 @@ Class | Method | HTTP request | Description *ActionsApi* | [**get_quality_issues**](docs/ActionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues *ActionsApi* | [**get_quality_issues_calculation_status**](docs/ActionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status *ActionsApi* | [**get_raw_export**](docs/ActionsApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +*ActionsApi* | [**get_report_export**](docs/ActionsApi.md#get_report_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId} | (EXPERIMENTAL) Retrieve exported files +*ActionsApi* | [**get_report_export_metadata**](docs/ActionsApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context *ActionsApi* | [**get_slides_export**](docs/ActionsApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files *ActionsApi* | [**get_slides_export_metadata**](docs/ActionsApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context *ActionsApi* | [**get_tabular_export**](docs/ActionsApi.md#get_tabular_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} | Retrieve exported files *ActionsApi* | [**get_translation_tags**](docs/ActionsApi.md#get_translation_tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags. -*ActionsApi* | [**get_workflow_status**](docs/ActionsApi.md#get_workflow_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/status | *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* | [**inherited_entity_conflicts**](docs/ActionsApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds identifier conflicts in workspace hierarchy. @@ -739,17 +732,20 @@ Class | Method | HTTP request | Description *ActionsApi* | [**key_driver_analysis_result**](docs/ActionsApi.md#key_driver_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId} | (EXPERIMENTAL) Get key driver analysis result *ActionsApi* | [**label_permissions**](docs/ActionsApi.md#label_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions | Get Label Permissions *ActionsApi* | [**list_files**](docs/ActionsApi.md#list_files) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles | List datasource files +*ActionsApi* | [**list_flow_operations**](docs/ActionsApi.md#list_flow_operations) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/operations | (EXPERIMENTAL) List the operations of flows *ActionsApi* | [**list_llm_provider_models**](docs/ActionsApi.md#list_llm_provider_models) | **POST** /api/v1/actions/ai/llmProvider/listModels | List LLM Provider Models *ActionsApi* | [**list_llm_provider_models_by_id**](docs/ActionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id *ActionsApi* | [**list_workspace_user_groups**](docs/ActionsApi.md#list_workspace_user_groups) | **GET** /api/v1/actions/workspaces/{workspaceId}/userGroups | *ActionsApi* | [**list_workspace_users**](docs/ActionsApi.md#list_workspace_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/users | *ActionsApi* | [**manage_attribute_permissions**](docs/ActionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute +*ActionsApi* | [**manage_computed_attribute_permissions**](docs/ActionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute *ActionsApi* | [**manage_dashboard_permissions**](docs/ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard *ActionsApi* | [**manage_data_source_permissions**](docs/ActionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source *ActionsApi* | [**manage_fact_permissions**](docs/ActionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact *ActionsApi* | [**manage_label_permissions**](docs/ActionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label *ActionsApi* | [**manage_metric_permissions**](docs/ActionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric *ActionsApi* | [**manage_organization_permissions**](docs/ActionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization +*ActionsApi* | [**manage_visualization_permissions**](docs/ActionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization *ActionsApi* | [**manage_workspace_permissions**](docs/ActionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace *ActionsApi* | [**mark_as_read_notification**](docs/ActionsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. *ActionsApi* | [**mark_as_read_notification_all**](docs/ActionsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. @@ -761,6 +757,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**particular_platform_usage**](docs/ActionsApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items. *ActionsApi* | [**pause_organization_automations**](docs/ActionsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces *ActionsApi* | [**pause_workspace_automations**](docs/ActionsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace +*ActionsApi* | [**process_invitation**](docs/ActionsApi.md#process_invitation) | **POST** /api/v1/actions/invite | Invite User *ActionsApi* | [**read_csv_file_manifests**](docs/ActionsApi.md#read_csv_file_manifests) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests | Read CSV file manifests *ActionsApi* | [**register_upload_notification**](docs/ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification *ActionsApi* | [**register_workspace_upload_notification**](docs/ActionsApi.md#register_workspace_upload_notification) | **POST** /api/v1/actions/workspaces/{workspaceId}/uploadNotification | Register an upload notification @@ -769,20 +766,23 @@ Class | Method | HTTP request | Description *ActionsApi* | [**resolve_all_entitlements**](docs/ActionsApi.md#resolve_all_entitlements) | **GET** /api/v1/actions/resolveEntitlements | Values for all public entitlements. *ActionsApi* | [**resolve_all_settings_without_workspace**](docs/ActionsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. *ActionsApi* | [**resolve_llm_endpoints**](docs/ActionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace (Removed) -*ActionsApi* | [**resolve_llm_providers**](docs/ActionsApi.md#resolve_llm_providers) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders | Get Active LLM configuration for this workspace *ActionsApi* | [**resolve_requested_entitlements**](docs/ActionsApi.md#resolve_requested_entitlements) | **POST** /api/v1/actions/resolveEntitlements | Values for requested public entitlements. *ActionsApi* | [**resolve_settings_without_workspace**](docs/ActionsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace. *ActionsApi* | [**retrieve_execution_metadata**](docs/ActionsApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata. +*ActionsApi* | [**retrieve_flow_result_binary**](docs/ActionsApi.md#retrieve_flow_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary | (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format +*ActionsApi* | [**retrieve_flow_result_metadata**](docs/ActionsApi.md#retrieve_flow_result_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata | (EXPERIMENTAL) Get the metadata of a flow result +*ActionsApi* | [**retrieve_flow_result_table**](docs/ActionsApi.md#retrieve_flow_result_table) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table | (EXPERIMENTAL) Get a page of a flow result *ActionsApi* | [**retrieve_result**](docs/ActionsApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result *ActionsApi* | [**retrieve_result_binary**](docs/ActionsApi.md#retrieve_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary | (BETA) Get a single execution result in Apache Arrow File or Stream format *ActionsApi* | [**retrieve_translations**](docs/ActionsApi.md#retrieve_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities. *ActionsApi* | [**scan_data_source**](docs/ActionsApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM) *ActionsApi* | [**scan_sql**](docs/ActionsApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query -*ActionsApi* | [**scan_statistics**](docs/ActionsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a StarRocks data source +*ActionsApi* | [**scan_statistics**](docs/ActionsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a data source *ActionsApi* | [**set_certification**](docs/ActionsApi.md#set_certification) | **POST** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification *ActionsApi* | [**set_translations**](docs/ActionsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities. *ActionsApi* | [**staging_upload**](docs/ActionsApi.md#staging_upload) | **POST** /api/v1/actions/fileStorage/staging/upload | Upload a file to the staging area *ActionsApi* | [**switch_active_identity_provider**](docs/ActionsApi.md#switch_active_identity_provider) | **POST** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider +*ActionsApi* | [**sync_metadata**](docs/ActionsApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization *ActionsApi* | [**tags**](docs/ActionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags *ActionsApi* | [**test_data_source**](docs/ActionsApi.md#test_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/test | Test data source connection by data source id *ActionsApi* | [**test_data_source_definition**](docs/ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition @@ -803,6 +803,7 @@ Class | Method | HTTP request | Description *ActionsApi* | [**unsubscribe_workspace_automations**](docs/ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace *ActionsApi* | [**validate_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_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 @@ -852,6 +853,13 @@ Class | Method | HTTP request | Description *ColorPaletteControllerApi* | [**get_entity_color_palettes**](docs/ColorPaletteControllerApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette *ColorPaletteControllerApi* | [**patch_entity_color_palettes**](docs/ColorPaletteControllerApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette *ColorPaletteControllerApi* | [**update_entity_color_palettes**](docs/ColorPaletteControllerApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette +*ComputedAttributeControllerApi* | [**create_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes +*ComputedAttributeControllerApi* | [**delete_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute +*ComputedAttributeControllerApi* | [**get_all_entities_computed_attributes**](docs/ComputedAttributeControllerApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes +*ComputedAttributeControllerApi* | [**get_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute +*ComputedAttributeControllerApi* | [**patch_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute +*ComputedAttributeControllerApi* | [**search_entities_computed_attributes**](docs/ComputedAttributeControllerApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +*ComputedAttributeControllerApi* | [**update_entity_computed_attributes**](docs/ComputedAttributeControllerApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute *CookieSecurityConfigurationControllerApi* | [**get_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration *CookieSecurityConfigurationControllerApi* | [**patch_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration *CookieSecurityConfigurationControllerApi* | [**update_entity_cookie_security_configurations**](docs/CookieSecurityConfigurationControllerApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration @@ -905,6 +913,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_attribute_hierarchies**](docs/EntitiesApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies *EntitiesApi* | [**create_entity_automations**](docs/EntitiesApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations *EntitiesApi* | [**create_entity_color_palettes**](docs/EntitiesApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes +*EntitiesApi* | [**create_entity_computed_attributes**](docs/EntitiesApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes *EntitiesApi* | [**create_entity_csp_directives**](docs/EntitiesApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives *EntitiesApi* | [**create_entity_custom_application_settings**](docs/EntitiesApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings *EntitiesApi* | [**create_entity_custom_geo_collections**](docs/EntitiesApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections @@ -926,6 +935,9 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**create_entity_org_memory_items**](docs/EntitiesApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities *EntitiesApi* | [**create_entity_organization_settings**](docs/EntitiesApi.md#create_entity_organization_settings) | **POST** /api/v1/entities/organizationSettings | Post Organization Setting entities *EntitiesApi* | [**create_entity_parameters**](docs/EntitiesApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters +*EntitiesApi* | [**create_entity_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 +*EntitiesApi* | [**create_entity_reports**](docs/EntitiesApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report *EntitiesApi* | [**create_entity_themes**](docs/EntitiesApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming *EntitiesApi* | [**create_entity_user_data_filters**](docs/EntitiesApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters *EntitiesApi* | [**create_entity_user_groups**](docs/EntitiesApi.md#create_entity_user_groups) | **POST** /api/v1/entities/userGroups | Post User Group entities @@ -946,6 +958,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_attribute_hierarchies**](docs/EntitiesApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy *EntitiesApi* | [**delete_entity_automations**](docs/EntitiesApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation *EntitiesApi* | [**delete_entity_color_palettes**](docs/EntitiesApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette +*EntitiesApi* | [**delete_entity_computed_attributes**](docs/EntitiesApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute *EntitiesApi* | [**delete_entity_csp_directives**](docs/EntitiesApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives *EntitiesApi* | [**delete_entity_custom_application_settings**](docs/EntitiesApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting *EntitiesApi* | [**delete_entity_custom_geo_collections**](docs/EntitiesApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection @@ -967,6 +980,9 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**delete_entity_org_memory_items**](docs/EntitiesApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity *EntitiesApi* | [**delete_entity_organization_settings**](docs/EntitiesApi.md#delete_entity_organization_settings) | **DELETE** /api/v1/entities/organizationSettings/{id} | Delete Organization Setting entity *EntitiesApi* | [**delete_entity_parameters**](docs/EntitiesApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter +*EntitiesApi* | [**delete_entity_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 +*EntitiesApi* | [**delete_entity_reports**](docs/EntitiesApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report *EntitiesApi* | [**delete_entity_themes**](docs/EntitiesApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming *EntitiesApi* | [**delete_entity_user_data_filters**](docs/EntitiesApi.md#delete_entity_user_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Delete a User Data Filter *EntitiesApi* | [**delete_entity_user_groups**](docs/EntitiesApi.md#delete_entity_user_groups) | **DELETE** /api/v1/entities/userGroups/{id} | Delete UserGroup entity @@ -990,6 +1006,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_attributes**](docs/EntitiesApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes *EntitiesApi* | [**get_all_entities_automations**](docs/EntitiesApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations *EntitiesApi* | [**get_all_entities_color_palettes**](docs/EntitiesApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes +*EntitiesApi* | [**get_all_entities_computed_attributes**](docs/EntitiesApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes *EntitiesApi* | [**get_all_entities_csp_directives**](docs/EntitiesApi.md#get_all_entities_csp_directives) | **GET** /api/v1/entities/cspDirectives | Get CSP Directives *EntitiesApi* | [**get_all_entities_custom_application_settings**](docs/EntitiesApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings *EntitiesApi* | [**get_all_entities_custom_geo_collections**](docs/EntitiesApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections @@ -1018,6 +1035,9 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_all_entities_org_memory_items**](docs/EntitiesApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities *EntitiesApi* | [**get_all_entities_organization_settings**](docs/EntitiesApi.md#get_all_entities_organization_settings) | **GET** /api/v1/entities/organizationSettings | Get Organization Setting entities *EntitiesApi* | [**get_all_entities_parameters**](docs/EntitiesApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters +*EntitiesApi* | [**get_all_entities_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 +*EntitiesApi* | [**get_all_entities_reports**](docs/EntitiesApi.md#get_all_entities_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports | Get all Reports *EntitiesApi* | [**get_all_entities_themes**](docs/EntitiesApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities *EntitiesApi* | [**get_all_entities_user_data_filters**](docs/EntitiesApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters *EntitiesApi* | [**get_all_entities_user_groups**](docs/EntitiesApi.md#get_all_entities_user_groups) | **GET** /api/v1/entities/userGroups | Get UserGroup entities @@ -1043,6 +1063,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_attributes**](docs/EntitiesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute *EntitiesApi* | [**get_entity_automations**](docs/EntitiesApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation *EntitiesApi* | [**get_entity_color_palettes**](docs/EntitiesApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette +*EntitiesApi* | [**get_entity_computed_attributes**](docs/EntitiesApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute *EntitiesApi* | [**get_entity_cookie_security_configurations**](docs/EntitiesApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration *EntitiesApi* | [**get_entity_csp_directives**](docs/EntitiesApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives *EntitiesApi* | [**get_entity_custom_application_settings**](docs/EntitiesApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting @@ -1073,6 +1094,9 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**get_entity_organization_settings**](docs/EntitiesApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization Setting entity *EntitiesApi* | [**get_entity_organizations**](docs/EntitiesApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations *EntitiesApi* | [**get_entity_parameters**](docs/EntitiesApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter +*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 +*EntitiesApi* | [**get_entity_reports**](docs/EntitiesApi.md#get_entity_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Get a Report *EntitiesApi* | [**get_entity_themes**](docs/EntitiesApi.md#get_entity_themes) | **GET** /api/v1/entities/themes/{id} | Get Theming *EntitiesApi* | [**get_entity_user_data_filters**](docs/EntitiesApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter *EntitiesApi* | [**get_entity_user_groups**](docs/EntitiesApi.md#get_entity_user_groups) | **GET** /api/v1/entities/userGroups/{id} | Get UserGroup entity @@ -1095,6 +1119,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_attributes**](docs/EntitiesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) *EntitiesApi* | [**patch_entity_automations**](docs/EntitiesApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation *EntitiesApi* | [**patch_entity_color_palettes**](docs/EntitiesApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette +*EntitiesApi* | [**patch_entity_computed_attributes**](docs/EntitiesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute *EntitiesApi* | [**patch_entity_cookie_security_configurations**](docs/EntitiesApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration *EntitiesApi* | [**patch_entity_csp_directives**](docs/EntitiesApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives *EntitiesApi* | [**patch_entity_custom_application_settings**](docs/EntitiesApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting @@ -1119,6 +1144,9 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**patch_entity_organization_settings**](docs/EntitiesApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization Setting entity *EntitiesApi* | [**patch_entity_organizations**](docs/EntitiesApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization *EntitiesApi* | [**patch_entity_parameters**](docs/EntitiesApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter +*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 +*EntitiesApi* | [**patch_entity_reports**](docs/EntitiesApi.md#patch_entity_reports) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Patch a Report *EntitiesApi* | [**patch_entity_themes**](docs/EntitiesApi.md#patch_entity_themes) | **PATCH** /api/v1/entities/themes/{id} | Patch Theming *EntitiesApi* | [**patch_entity_user_data_filters**](docs/EntitiesApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter *EntitiesApi* | [**patch_entity_user_groups**](docs/EntitiesApi.md#patch_entity_user_groups) | **PATCH** /api/v1/entities/userGroups/{id} | Patch UserGroup entity @@ -1137,6 +1165,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**search_entities_attributes**](docs/EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_automation_results**](docs/EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_automations**](docs/EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +*EntitiesApi* | [**search_entities_computed_attributes**](docs/EntitiesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_custom_application_settings**](docs/EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_dashboard_plugins**](docs/EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) *EntitiesApi* | [**search_entities_datasets**](docs/EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) @@ -1160,6 +1189,7 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_attribute_hierarchies**](docs/EntitiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy *EntitiesApi* | [**update_entity_automations**](docs/EntitiesApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation *EntitiesApi* | [**update_entity_color_palettes**](docs/EntitiesApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette +*EntitiesApi* | [**update_entity_computed_attributes**](docs/EntitiesApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute *EntitiesApi* | [**update_entity_cookie_security_configurations**](docs/EntitiesApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration *EntitiesApi* | [**update_entity_csp_directives**](docs/EntitiesApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives *EntitiesApi* | [**update_entity_custom_application_settings**](docs/EntitiesApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting @@ -1183,6 +1213,9 @@ Class | Method | HTTP request | Description *EntitiesApi* | [**update_entity_organization_settings**](docs/EntitiesApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization Setting entity *EntitiesApi* | [**update_entity_organizations**](docs/EntitiesApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization *EntitiesApi* | [**update_entity_parameters**](docs/EntitiesApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter +*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 +*EntitiesApi* | [**update_entity_reports**](docs/EntitiesApi.md#update_entity_reports) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Put a Report *EntitiesApi* | [**update_entity_themes**](docs/EntitiesApi.md#update_entity_themes) | **PUT** /api/v1/entities/themes/{id} | Put Theming *EntitiesApi* | [**update_entity_user_data_filters**](docs/EntitiesApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter *EntitiesApi* | [**update_entity_user_groups**](docs/EntitiesApi.md#update_entity_user_groups) | **PUT** /api/v1/entities/userGroups/{id} | Put UserGroup entity @@ -1358,6 +1391,24 @@ Class | Method | HTTP request | Description *ParameterControllerApi* | [**patch_entity_parameters**](docs/ParameterControllerApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter *ParameterControllerApi* | [**search_entities_parameters**](docs/ParameterControllerApi.md#search_entities_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters/search | The search endpoint (beta) *ParameterControllerApi* | [**update_entity_parameters**](docs/ParameterControllerApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter +*ReportControllerApi* | [**create_entity_reports**](docs/ReportControllerApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report +*ReportControllerApi* | [**delete_entity_reports**](docs/ReportControllerApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report +*ReportControllerApi* | [**get_all_entities_reports**](docs/ReportControllerApi.md#get_all_entities_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports | Get all Reports +*ReportControllerApi* | [**get_entity_reports**](docs/ReportControllerApi.md#get_entity_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Get a Report +*ReportControllerApi* | [**patch_entity_reports**](docs/ReportControllerApi.md#patch_entity_reports) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Patch a Report +*ReportControllerApi* | [**update_entity_reports**](docs/ReportControllerApi.md#update_entity_reports) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Put a Report +*ReportPageLayoutControllerApi* | [**create_entity_report_page_layouts**](docs/ReportPageLayoutControllerApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout +*ReportPageLayoutControllerApi* | [**delete_entity_report_page_layouts**](docs/ReportPageLayoutControllerApi.md#delete_entity_report_page_layouts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Delete a Report Page Layout +*ReportPageLayoutControllerApi* | [**get_all_entities_report_page_layouts**](docs/ReportPageLayoutControllerApi.md#get_all_entities_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Get all Report Page Layouts +*ReportPageLayoutControllerApi* | [**get_entity_report_page_layouts**](docs/ReportPageLayoutControllerApi.md#get_entity_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Get a Report Page Layout +*ReportPageLayoutControllerApi* | [**patch_entity_report_page_layouts**](docs/ReportPageLayoutControllerApi.md#patch_entity_report_page_layouts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Patch a Report Page Layout +*ReportPageLayoutControllerApi* | [**update_entity_report_page_layouts**](docs/ReportPageLayoutControllerApi.md#update_entity_report_page_layouts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Put a Report Page Layout +*ReportTemplateControllerApi* | [**create_entity_report_templates**](docs/ReportTemplateControllerApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template +*ReportTemplateControllerApi* | [**delete_entity_report_templates**](docs/ReportTemplateControllerApi.md#delete_entity_report_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Delete a Report Template +*ReportTemplateControllerApi* | [**get_all_entities_report_templates**](docs/ReportTemplateControllerApi.md#get_all_entities_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Get all Report Templates +*ReportTemplateControllerApi* | [**get_entity_report_templates**](docs/ReportTemplateControllerApi.md#get_entity_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Get a Report Template +*ReportTemplateControllerApi* | [**patch_entity_report_templates**](docs/ReportTemplateControllerApi.md#patch_entity_report_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Patch a Report Template +*ReportTemplateControllerApi* | [**update_entity_report_templates**](docs/ReportTemplateControllerApi.md#update_entity_report_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Put a Report Template *ThemeControllerApi* | [**create_entity_themes**](docs/ThemeControllerApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming *ThemeControllerApi* | [**delete_entity_themes**](docs/ThemeControllerApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming *ThemeControllerApi* | [**get_all_entities_themes**](docs/ThemeControllerApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities @@ -1452,13 +1503,14 @@ Class | Method | HTTP request | Description - [AbsoluteGranularityDateFilter](docs/AbsoluteGranularityDateFilter.md) - [AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter](docs/AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter.md) - [AbstractMeasureValueFilter](docs/AbstractMeasureValueFilter.md) - - [ActiveObjectIdentification](docs/ActiveObjectIdentification.md) - [AdHocAutomation](docs/AdHocAutomation.md) - [AddDatabaseDataSourceRequest](docs/AddDatabaseDataSourceRequest.md) - [AddDatabaseDataSourceResponse](docs/AddDatabaseDataSourceResponse.md) - [AfmCancelTokens](docs/AfmCancelTokens.md) - [AfmExecution](docs/AfmExecution.md) - [AfmExecutionResponse](docs/AfmExecutionResponse.md) + - [AfmFlowInput](docs/AfmFlowInput.md) + - [AfmFlowInputAllOf](docs/AfmFlowInputAllOf.md) - [AfmIdentifier](docs/AfmIdentifier.md) - [AfmLocalIdentifier](docs/AfmLocalIdentifier.md) - [AfmObjectIdentifier](docs/AfmObjectIdentifier.md) @@ -1477,8 +1529,6 @@ Class | Method | HTTP request | Description - [AfmValidDescendantsResponse](docs/AfmValidDescendantsResponse.md) - [AfmValidObjectsQuery](docs/AfmValidObjectsQuery.md) - [AfmValidObjectsResponse](docs/AfmValidObjectsResponse.md) - - [AggregateKeyConfig](docs/AggregateKeyConfig.md) - - [AiUsageMetadataItem](docs/AiUsageMetadataItem.md) - [AlertAfm](docs/AlertAfm.md) - [AlertCondition](docs/AlertCondition.md) - [AlertConditionOperand](docs/AlertConditionOperand.md) @@ -1486,7 +1536,6 @@ Class | Method | HTTP request | Description - [AlertEvaluationRow](docs/AlertEvaluationRow.md) - [AllTimeDateFilter](docs/AllTimeDateFilter.md) - [AllTimeDateFilterAllTimeDateFilter](docs/AllTimeDateFilterAllTimeDateFilter.md) - - [AllowedRelationshipType](docs/AllowedRelationshipType.md) - [AmplitudeService](docs/AmplitudeService.md) - [AnalyticsCatalogCreatedBy](docs/AnalyticsCatalogCreatedBy.md) - [AnalyticsCatalogTags](docs/AnalyticsCatalogTags.md) @@ -1499,7 +1548,6 @@ Class | Method | HTTP request | Description - [AnalyzeCsvResponseConfig](docs/AnalyzeCsvResponseConfig.md) - [AnalyzeStatisticsRequest](docs/AnalyzeStatisticsRequest.md) - [AnomalyDetection](docs/AnomalyDetection.md) - - [AnomalyDetectionConfig](docs/AnomalyDetectionConfig.md) - [AnomalyDetectionRequest](docs/AnomalyDetectionRequest.md) - [AnomalyDetectionResult](docs/AnomalyDetectionResult.md) - [AnomalyDetectionWrapper](docs/AnomalyDetectionWrapper.md) @@ -1525,16 +1573,12 @@ Class | Method | HTTP request | Description - [AttributeHeader](docs/AttributeHeader.md) - [AttributeHeaderAttributeHeader](docs/AttributeHeaderAttributeHeader.md) - [AttributeItem](docs/AttributeItem.md) - - [AttributeNegativeFilter](docs/AttributeNegativeFilter.md) - - [AttributeNegativeFilterAllOf](docs/AttributeNegativeFilterAllOf.md) - [AttributePermissions](docs/AttributePermissions.md) - [AttributePermissionsAssignment](docs/AttributePermissionsAssignment.md) - [AttributePermissionsForAssignee](docs/AttributePermissionsForAssignee.md) - [AttributePermissionsForAssigneeAllOf](docs/AttributePermissionsForAssigneeAllOf.md) - [AttributePermissionsForAssigneeRule](docs/AttributePermissionsForAssigneeRule.md) - [AttributePermissionsForAssigneeRuleAllOf](docs/AttributePermissionsForAssigneeRuleAllOf.md) - - [AttributePositiveFilter](docs/AttributePositiveFilter.md) - - [AttributePositiveFilterAllOf](docs/AttributePositiveFilterAllOf.md) - [AttributeResultHeader](docs/AttributeResultHeader.md) - [AutomationAlert](docs/AutomationAlert.md) - [AutomationDashboardTabularExport](docs/AutomationDashboardTabularExport.md) @@ -1565,25 +1609,13 @@ Class | Method | HTTP request | Description - [CalendarDefinition](docs/CalendarDefinition.md) - [CalendarGranularity](docs/CalendarGranularity.md) - [CalendarTableReference](docs/CalendarTableReference.md) - - [CertificationInfo](docs/CertificationInfo.md) - - [ChangeAnalysisParams](docs/ChangeAnalysisParams.md) - [ChangeAnalysisRequest](docs/ChangeAnalysisRequest.md) - [ChangeAnalysisResponse](docs/ChangeAnalysisResponse.md) - [ChangeAnalysisResult](docs/ChangeAnalysisResult.md) - - [ChatHistoryInteraction](docs/ChatHistoryInteraction.md) - - [ChatHistoryRequest](docs/ChatHistoryRequest.md) - - [ChatHistoryResult](docs/ChatHistoryResult.md) - - [ChatRequest](docs/ChatRequest.md) - - [ChatResult](docs/ChatResult.md) - - [ChatUsageResponse](docs/ChatUsageResponse.md) - - [ClusteringConfig](docs/ClusteringConfig.md) - [ClusteringRequest](docs/ClusteringRequest.md) - [ClusteringResult](docs/ClusteringResult.md) - - [ColumnExpression](docs/ColumnExpression.md) - - [ColumnInfo](docs/ColumnInfo.md) - [ColumnLocation](docs/ColumnLocation.md) - [ColumnOverride](docs/ColumnOverride.md) - - [ColumnPartitionConfig](docs/ColumnPartitionConfig.md) - [ColumnStatistic](docs/ColumnStatistic.md) - [ColumnStatisticWarning](docs/ColumnStatisticWarning.md) - [ColumnStatisticsEntry](docs/ColumnStatisticsEntry.md) @@ -1599,17 +1631,35 @@ Class | Method | HTTP request | Description - [ComparisonWrapper](docs/ComparisonWrapper.md) - [CompoundMeasureValueFilter](docs/CompoundMeasureValueFilter.md) - [CompoundMeasureValueFilterCompoundMeasureValueFilter](docs/CompoundMeasureValueFilterCompoundMeasureValueFilter.md) + - [ComputedAttributePermissions](docs/ComputedAttributePermissions.md) + - [ComputedAttributePermissionsAssignment](docs/ComputedAttributePermissionsAssignment.md) + - [ComputedAttributePermissionsForAssignee](docs/ComputedAttributePermissionsForAssignee.md) + - [ComputedAttributePermissionsForAssigneeRule](docs/ComputedAttributePermissionsForAssigneeRule.md) + - [ConditionalFormatting](docs/ConditionalFormatting.md) + - [ConditionalFormattingAbsoluteDateValue](docs/ConditionalFormattingAbsoluteDateValue.md) + - [ConditionalFormattingAbsoluteDateValueAllOf](docs/ConditionalFormattingAbsoluteDateValueAllOf.md) + - [ConditionalFormattingAttributeTarget](docs/ConditionalFormattingAttributeTarget.md) + - [ConditionalFormattingAttributeTargetAllOf](docs/ConditionalFormattingAttributeTargetAllOf.md) + - [ConditionalFormattingCondition](docs/ConditionalFormattingCondition.md) + - [ConditionalFormattingFormat](docs/ConditionalFormattingFormat.md) + - [ConditionalFormattingLiteral](docs/ConditionalFormattingLiteral.md) + - [ConditionalFormattingLiteralRangeValue](docs/ConditionalFormattingLiteralRangeValue.md) + - [ConditionalFormattingLiteralRangeValueAllOf](docs/ConditionalFormattingLiteralRangeValueAllOf.md) + - [ConditionalFormattingLiteralValue](docs/ConditionalFormattingLiteralValue.md) + - [ConditionalFormattingLiteralValueAllOf](docs/ConditionalFormattingLiteralValueAllOf.md) + - [ConditionalFormattingMeasureTarget](docs/ConditionalFormattingMeasureTarget.md) + - [ConditionalFormattingMeasureTargetAllOf](docs/ConditionalFormattingMeasureTargetAllOf.md) + - [ConditionalFormattingNoneValue](docs/ConditionalFormattingNoneValue.md) + - [ConditionalFormattingNoneValueAllOf](docs/ConditionalFormattingNoneValueAllOf.md) + - [ConditionalFormattingRelativeDateValue](docs/ConditionalFormattingRelativeDateValue.md) + - [ConditionalFormattingRelativeDateValueAllOf](docs/ConditionalFormattingRelativeDateValueAllOf.md) + - [ConditionalFormattingRule](docs/ConditionalFormattingRule.md) + - [ConditionalFormattingTarget](docs/ConditionalFormattingTarget.md) + - [ConditionalFormattingValue](docs/ConditionalFormattingValue.md) - [ContentSlideTemplate](docs/ContentSlideTemplate.md) - [ConvertGeoFileRequest](docs/ConvertGeoFileRequest.md) - [ConvertGeoFileResponse](docs/ConvertGeoFileResponse.md) - [CoverSlideTemplate](docs/CoverSlideTemplate.md) - - [CreatePipeTableRequest](docs/CreatePipeTableRequest.md) - - [CreatePipeTableRequestDistributionConfig](docs/CreatePipeTableRequestDistributionConfig.md) - - [CreatePipeTableRequestKeyConfig](docs/CreatePipeTableRequestKeyConfig.md) - - [CreatePipeTableRequestPartitionConfig](docs/CreatePipeTableRequestPartitionConfig.md) - - [CreatedVisualization](docs/CreatedVisualization.md) - - [CreatedVisualizationFiltersInner](docs/CreatedVisualizationFiltersInner.md) - - [CreatedVisualizations](docs/CreatedVisualizations.md) - [CsvConvertOptions](docs/CsvConvertOptions.md) - [CsvConvertOptionsColumnType](docs/CsvConvertOptionsColumnType.md) - [CsvManifestBody](docs/CsvManifestBody.md) @@ -1629,7 +1679,6 @@ Class | Method | HTTP request | Description - [DashboardCompoundConditionItem](docs/DashboardCompoundConditionItem.md) - [DashboardCompoundRangeCondition](docs/DashboardCompoundRangeCondition.md) - [DashboardCompoundRangeConditionRange](docs/DashboardCompoundRangeConditionRange.md) - - [DashboardContext](docs/DashboardContext.md) - [DashboardDateFilter](docs/DashboardDateFilter.md) - [DashboardDateFilterDateFilter](docs/DashboardDateFilterDateFilter.md) - [DashboardDateFilterDateFilterFrom](docs/DashboardDateFilterDateFilterFrom.md) @@ -1657,12 +1706,7 @@ Class | Method | HTTP request | Description - [DatasetGrain](docs/DatasetGrain.md) - [DatasetReferenceIdentifier](docs/DatasetReferenceIdentifier.md) - [DatasetWorkspaceDataFilterIdentifier](docs/DatasetWorkspaceDataFilterIdentifier.md) - - [DateAbsoluteFilter](docs/DateAbsoluteFilter.md) - - [DateAbsoluteFilterAllOf](docs/DateAbsoluteFilterAllOf.md) - [DateFilter](docs/DateFilter.md) - - [DateRelativeFilter](docs/DateRelativeFilter.md) - - [DateRelativeFilterAllOf](docs/DateRelativeFilterAllOf.md) - - [DateTruncPartitionConfig](docs/DateTruncPartitionConfig.md) - [DateValue](docs/DateValue.md) - [DeclarativeAgent](docs/DeclarativeAgent.md) - [DeclarativeAgents](docs/DeclarativeAgents.md) @@ -1683,6 +1727,8 @@ Class | Method | HTTP request | Description - [DeclarativeCalendar](docs/DeclarativeCalendar.md) - [DeclarativeColorPalette](docs/DeclarativeColorPalette.md) - [DeclarativeColumn](docs/DeclarativeColumn.md) + - [DeclarativeComputedAttribute](docs/DeclarativeComputedAttribute.md) + - [DeclarativeComputedAttributeContent](docs/DeclarativeComputedAttributeContent.md) - [DeclarativeCspDirective](docs/DeclarativeCspDirective.md) - [DeclarativeCustomApplicationSetting](docs/DeclarativeCustomApplicationSetting.md) - [DeclarativeCustomGeoCollection](docs/DeclarativeCustomGeoCollection.md) @@ -1723,6 +1769,9 @@ Class | Method | HTTP request | Description - [DeclarativeParameter](docs/DeclarativeParameter.md) - [DeclarativeReference](docs/DeclarativeReference.md) - [DeclarativeReferenceSource](docs/DeclarativeReferenceSource.md) + - [DeclarativeReport](docs/DeclarativeReport.md) + - [DeclarativeReportPageLayout](docs/DeclarativeReportPageLayout.md) + - [DeclarativeReportTemplate](docs/DeclarativeReportTemplate.md) - [DeclarativeRsaSpecification](docs/DeclarativeRsaSpecification.md) - [DeclarativeSetting](docs/DeclarativeSetting.md) - [DeclarativeSingleWorkspacePermission](docs/DeclarativeSingleWorkspacePermission.md) @@ -1771,11 +1820,8 @@ Class | Method | HTTP request | Description - [DependsOnItem](docs/DependsOnItem.md) - [DependsOnMatchFilter](docs/DependsOnMatchFilter.md) - [DependsOnMatchFilterAllOf](docs/DependsOnMatchFilterAllOf.md) - - [DimAttribute](docs/DimAttribute.md) - [Dimension](docs/Dimension.md) - [DimensionHeader](docs/DimensionHeader.md) - - [DistributionConfig](docs/DistributionConfig.md) - - [DuplicateKeyConfig](docs/DuplicateKeyConfig.md) - [Element](docs/Element.md) - [ElementsRequest](docs/ElementsRequest.md) - [ElementsRequestDependsOnInner](docs/ElementsRequestDependsOnInner.md) @@ -1785,7 +1831,6 @@ Class | Method | HTTP request | Description - [EntitySearchBody](docs/EntitySearchBody.md) - [EntitySearchPage](docs/EntitySearchPage.md) - [EntitySearchSort](docs/EntitySearchSort.md) - - [ErrorInfo](docs/ErrorInfo.md) - [ExecutionLinks](docs/ExecutionLinks.md) - [ExecutionResponse](docs/ExecutionResponse.md) - [ExecutionResult](docs/ExecutionResult.md) @@ -1808,22 +1853,31 @@ Class | Method | HTTP request | Description - [FeatureFlagsContext](docs/FeatureFlagsContext.md) - [Features](docs/Features.md) - [File](docs/File.md) - - [Filter](docs/Filter.md) + - [FileFlowInput](docs/FileFlowInput.md) + - [FileFlowInputAllOf](docs/FileFlowInputAllOf.md) - [FilterBy](docs/FilterBy.md) - [FilterDefinition](docs/FilterDefinition.md) - [FilterDefinitionForSimpleMeasure](docs/FilterDefinitionForSimpleMeasure.md) - [FiscalYearCalendarDefinition](docs/FiscalYearCalendarDefinition.md) - [FiscalYearCalendarDefinitionAllOf](docs/FiscalYearCalendarDefinitionAllOf.md) - - [ForecastConfig](docs/ForecastConfig.md) + - [FlowColumn](docs/FlowColumn.md) + - [FlowExecutionResponse](docs/FlowExecutionResponse.md) + - [FlowInput](docs/FlowInput.md) + - [FlowOperationDescriptor](docs/FlowOperationDescriptor.md) + - [FlowOperationInput](docs/FlowOperationInput.md) + - [FlowOperationOutput](docs/FlowOperationOutput.md) + - [FlowOperations](docs/FlowOperations.md) + - [FlowRequest](docs/FlowRequest.md) + - [FlowResultMetadata](docs/FlowResultMetadata.md) + - [FlowTablePaging](docs/FlowTablePaging.md) + - [FlowTableResult](docs/FlowTableResult.md) + - [FlowTransformation](docs/FlowTransformation.md) - [ForecastRequest](docs/ForecastRequest.md) - [ForecastResult](docs/ForecastResult.md) - - [FoundObjects](docs/FoundObjects.md) - [Frequency](docs/Frequency.md) - [FrequencyBucket](docs/FrequencyBucket.md) - [FrequencyProperties](docs/FrequencyProperties.md) - [GdStorageFile](docs/GdStorageFile.md) - - [GenAiRankingFilter](docs/GenAiRankingFilter.md) - - [GenAiRankingFilterAllOf](docs/GenAiRankingFilterAllOf.md) - [GenerateDescriptionRequest](docs/GenerateDescriptionRequest.md) - [GenerateDescriptionResponse](docs/GenerateDescriptionResponse.md) - [GenerateLdmRequest](docs/GenerateLdmRequest.md) @@ -1841,7 +1895,6 @@ Class | Method | HTTP request | Description - [GrainIdentifier](docs/GrainIdentifier.md) - [GrantedPermission](docs/GrantedPermission.md) - [GranularitiesFormatting](docs/GranularitiesFormatting.md) - - [HashDistributionConfig](docs/HashDistributionConfig.md) - [HeaderGroup](docs/HeaderGroup.md) - [HierarchyObjectIdentification](docs/HierarchyObjectIdentification.md) - [Histogram](docs/Histogram.md) @@ -1865,17 +1918,20 @@ Class | Method | HTTP request | Description - [InlineFilterDefinitionInline](docs/InlineFilterDefinitionInline.md) - [InlineMeasureDefinition](docs/InlineMeasureDefinition.md) - [InlineMeasureDefinitionInline](docs/InlineMeasureDefinitionInline.md) - - [InsightWidgetDescriptor](docs/InsightWidgetDescriptor.md) + - [Instruction](docs/Instruction.md) - [IntroSlideTemplate](docs/IntroSlideTemplate.md) + - [Invitation](docs/Invitation.md) - [IpAllowlistPolicyTargets](docs/IpAllowlistPolicyTargets.md) - [JsonApiAgentIn](docs/JsonApiAgentIn.md) - [JsonApiAgentInAttributes](docs/JsonApiAgentInAttributes.md) + - [JsonApiAgentInAttributesInstructionsInner](docs/JsonApiAgentInAttributesInstructionsInner.md) - [JsonApiAgentInDocument](docs/JsonApiAgentInDocument.md) - [JsonApiAgentInRelationships](docs/JsonApiAgentInRelationships.md) - [JsonApiAgentInRelationshipsUserGroups](docs/JsonApiAgentInRelationshipsUserGroups.md) - [JsonApiAgentOut](docs/JsonApiAgentOut.md) - [JsonApiAgentOutAttributes](docs/JsonApiAgentOutAttributes.md) - [JsonApiAgentOutDocument](docs/JsonApiAgentOutDocument.md) + - [JsonApiAgentOutDocumentMeta](docs/JsonApiAgentOutDocumentMeta.md) - [JsonApiAgentOutIncludes](docs/JsonApiAgentOutIncludes.md) - [JsonApiAgentOutList](docs/JsonApiAgentOutList.md) - [JsonApiAgentOutListMeta](docs/JsonApiAgentOutListMeta.md) @@ -1911,6 +1967,7 @@ Class | Method | HTTP request | Description - [JsonApiAnalyticalDashboardOutMetaAccessInfo](docs/JsonApiAnalyticalDashboardOutMetaAccessInfo.md) - [JsonApiAnalyticalDashboardOutRelationships](docs/JsonApiAnalyticalDashboardOutRelationships.md) - [JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards](docs/JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md) + - [JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes](docs/JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md) - [JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins](docs/JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md) - [JsonApiAnalyticalDashboardOutRelationshipsDatasets](docs/JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) - [JsonApiAnalyticalDashboardOutRelationshipsFilterContexts](docs/JsonApiAnalyticalDashboardOutRelationshipsFilterContexts.md) @@ -1932,6 +1989,7 @@ Class | Method | HTTP request | Description - [JsonApiApiTokenOutAttributes](docs/JsonApiApiTokenOutAttributes.md) - [JsonApiApiTokenOutDocument](docs/JsonApiApiTokenOutDocument.md) - [JsonApiApiTokenOutList](docs/JsonApiApiTokenOutList.md) + - [JsonApiApiTokenOutListMeta](docs/JsonApiApiTokenOutListMeta.md) - [JsonApiApiTokenOutWithLinks](docs/JsonApiApiTokenOutWithLinks.md) - [JsonApiAttributeHierarchyIn](docs/JsonApiAttributeHierarchyIn.md) - [JsonApiAttributeHierarchyInAttributes](docs/JsonApiAttributeHierarchyInAttributes.md) @@ -1951,9 +2009,11 @@ Class | Method | HTTP request | Description - [JsonApiAttributeLinkage](docs/JsonApiAttributeLinkage.md) - [JsonApiAttributeOut](docs/JsonApiAttributeOut.md) - [JsonApiAttributeOutAttributes](docs/JsonApiAttributeOutAttributes.md) + - [JsonApiAttributeOutAttributesConditionalFormatting](docs/JsonApiAttributeOutAttributesConditionalFormatting.md) - [JsonApiAttributeOutDocument](docs/JsonApiAttributeOutDocument.md) - [JsonApiAttributeOutIncludes](docs/JsonApiAttributeOutIncludes.md) - [JsonApiAttributeOutList](docs/JsonApiAttributeOutList.md) + - [JsonApiAttributeOutMeta](docs/JsonApiAttributeOutMeta.md) - [JsonApiAttributeOutRelationships](docs/JsonApiAttributeOutRelationships.md) - [JsonApiAttributeOutRelationshipsAttributeHierarchies](docs/JsonApiAttributeOutRelationshipsAttributeHierarchies.md) - [JsonApiAttributeOutRelationshipsDefaultView](docs/JsonApiAttributeOutRelationshipsDefaultView.md) @@ -1990,6 +2050,7 @@ Class | Method | HTTP request | Description - [JsonApiAutomationOutList](docs/JsonApiAutomationOutList.md) - [JsonApiAutomationOutRelationships](docs/JsonApiAutomationOutRelationships.md) - [JsonApiAutomationOutRelationshipsAutomationResults](docs/JsonApiAutomationOutRelationshipsAutomationResults.md) + - [JsonApiAutomationOutRelationshipsFacts](docs/JsonApiAutomationOutRelationshipsFacts.md) - [JsonApiAutomationOutWithLinks](docs/JsonApiAutomationOutWithLinks.md) - [JsonApiAutomationPatch](docs/JsonApiAutomationPatch.md) - [JsonApiAutomationPatchDocument](docs/JsonApiAutomationPatchDocument.md) @@ -2012,6 +2073,24 @@ Class | Method | HTTP request | Description - [JsonApiColorPalettePatch](docs/JsonApiColorPalettePatch.md) - [JsonApiColorPalettePatchAttributes](docs/JsonApiColorPalettePatchAttributes.md) - [JsonApiColorPalettePatchDocument](docs/JsonApiColorPalettePatchDocument.md) + - [JsonApiComputedAttributeIn](docs/JsonApiComputedAttributeIn.md) + - [JsonApiComputedAttributeInAttributes](docs/JsonApiComputedAttributeInAttributes.md) + - [JsonApiComputedAttributeInAttributesContent](docs/JsonApiComputedAttributeInAttributesContent.md) + - [JsonApiComputedAttributeInDocument](docs/JsonApiComputedAttributeInDocument.md) + - [JsonApiComputedAttributeLinkage](docs/JsonApiComputedAttributeLinkage.md) + - [JsonApiComputedAttributeOut](docs/JsonApiComputedAttributeOut.md) + - [JsonApiComputedAttributeOutAttributes](docs/JsonApiComputedAttributeOutAttributes.md) + - [JsonApiComputedAttributeOutDocument](docs/JsonApiComputedAttributeOutDocument.md) + - [JsonApiComputedAttributeOutIncludes](docs/JsonApiComputedAttributeOutIncludes.md) + - [JsonApiComputedAttributeOutList](docs/JsonApiComputedAttributeOutList.md) + - [JsonApiComputedAttributeOutRelationships](docs/JsonApiComputedAttributeOutRelationships.md) + - [JsonApiComputedAttributeOutWithLinks](docs/JsonApiComputedAttributeOutWithLinks.md) + - [JsonApiComputedAttributePatch](docs/JsonApiComputedAttributePatch.md) + - [JsonApiComputedAttributePatchAttributes](docs/JsonApiComputedAttributePatchAttributes.md) + - [JsonApiComputedAttributePatchDocument](docs/JsonApiComputedAttributePatchDocument.md) + - [JsonApiComputedAttributePostOptionalId](docs/JsonApiComputedAttributePostOptionalId.md) + - [JsonApiComputedAttributePostOptionalIdDocument](docs/JsonApiComputedAttributePostOptionalIdDocument.md) + - [JsonApiComputedAttributeToManyLinkage](docs/JsonApiComputedAttributeToManyLinkage.md) - [JsonApiCookieSecurityConfigurationIn](docs/JsonApiCookieSecurityConfigurationIn.md) - [JsonApiCookieSecurityConfigurationInAttributes](docs/JsonApiCookieSecurityConfigurationInAttributes.md) - [JsonApiCookieSecurityConfigurationInDocument](docs/JsonApiCookieSecurityConfigurationInDocument.md) @@ -2106,15 +2185,14 @@ Class | Method | HTTP request | Description - [JsonApiDatasetOutList](docs/JsonApiDatasetOutList.md) - [JsonApiDatasetOutRelationships](docs/JsonApiDatasetOutRelationships.md) - [JsonApiDatasetOutRelationshipsAggregatedFacts](docs/JsonApiDatasetOutRelationshipsAggregatedFacts.md) - - [JsonApiDatasetOutRelationshipsFacts](docs/JsonApiDatasetOutRelationshipsFacts.md) - [JsonApiDatasetOutRelationshipsWorkspaceDataFilters](docs/JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md) - [JsonApiDatasetOutWithLinks](docs/JsonApiDatasetOutWithLinks.md) - [JsonApiDatasetPatch](docs/JsonApiDatasetPatch.md) + - [JsonApiDatasetPatchAttributes](docs/JsonApiDatasetPatchAttributes.md) - [JsonApiDatasetPatchDocument](docs/JsonApiDatasetPatchDocument.md) - [JsonApiDatasetToManyLinkage](docs/JsonApiDatasetToManyLinkage.md) - [JsonApiDatasetToOneLinkage](docs/JsonApiDatasetToOneLinkage.md) - [JsonApiDocumentDatabaseInstance](docs/JsonApiDocumentDatabaseInstance.md) - - [JsonApiDocumentPipeTable](docs/JsonApiDocumentPipeTable.md) - [JsonApiEntitlementOut](docs/JsonApiEntitlementOut.md) - [JsonApiEntitlementOutAttributes](docs/JsonApiEntitlementOutAttributes.md) - [JsonApiEntitlementOutDocument](docs/JsonApiEntitlementOutDocument.md) @@ -2224,8 +2302,6 @@ Class | Method | HTTP request | Description - [JsonApiItemDataSourceInfo](docs/JsonApiItemDataSourceInfo.md) - [JsonApiItemDatabaseInstance](docs/JsonApiItemDatabaseInstance.md) - [JsonApiItemObjectStorageInfo](docs/JsonApiItemObjectStorageInfo.md) - - [JsonApiItemPipeTable](docs/JsonApiItemPipeTable.md) - - [JsonApiItemPipeTableSummary](docs/JsonApiItemPipeTableSummary.md) - [JsonApiItemServiceInfo](docs/JsonApiItemServiceInfo.md) - [JsonApiJwkIn](docs/JsonApiJwkIn.md) - [JsonApiJwkInAttributes](docs/JsonApiJwkInAttributes.md) @@ -2257,6 +2333,7 @@ Class | Method | HTTP request | Description - [JsonApiLabelLinkage](docs/JsonApiLabelLinkage.md) - [JsonApiLabelOut](docs/JsonApiLabelOut.md) - [JsonApiLabelOutAttributes](docs/JsonApiLabelOutAttributes.md) + - [JsonApiLabelOutAttributesConditionalFormatting](docs/JsonApiLabelOutAttributesConditionalFormatting.md) - [JsonApiLabelOutAttributesGeoAreaConfig](docs/JsonApiLabelOutAttributesGeoAreaConfig.md) - [JsonApiLabelOutAttributesTranslationsInner](docs/JsonApiLabelOutAttributesTranslationsInner.md) - [JsonApiLabelOutDocument](docs/JsonApiLabelOutDocument.md) @@ -2264,13 +2341,13 @@ Class | Method | HTTP request | Description - [JsonApiLabelOutRelationships](docs/JsonApiLabelOutRelationships.md) - [JsonApiLabelOutWithLinks](docs/JsonApiLabelOutWithLinks.md) - [JsonApiLabelPatch](docs/JsonApiLabelPatch.md) + - [JsonApiLabelPatchAttributes](docs/JsonApiLabelPatchAttributes.md) - [JsonApiLabelPatchDocument](docs/JsonApiLabelPatchDocument.md) - [JsonApiLabelToManyLinkage](docs/JsonApiLabelToManyLinkage.md) - [JsonApiLabelToOneLinkage](docs/JsonApiLabelToOneLinkage.md) - [JsonApiListDocumentDataSourceInfo](docs/JsonApiListDocumentDataSourceInfo.md) - [JsonApiListDocumentDatabaseInstance](docs/JsonApiListDocumentDatabaseInstance.md) - [JsonApiListDocumentObjectStorageInfo](docs/JsonApiListDocumentObjectStorageInfo.md) - - [JsonApiListDocumentPipeTableSummary](docs/JsonApiListDocumentPipeTableSummary.md) - [JsonApiListDocumentServiceInfo](docs/JsonApiListDocumentServiceInfo.md) - [JsonApiListLinks](docs/JsonApiListLinks.md) - [JsonApiListMeta](docs/JsonApiListMeta.md) @@ -2300,15 +2377,13 @@ Class | Method | HTTP request | Description - [JsonApiMemoryItemPostOptionalIdDocument](docs/JsonApiMemoryItemPostOptionalIdDocument.md) - [JsonApiMetricIn](docs/JsonApiMetricIn.md) - [JsonApiMetricInAttributes](docs/JsonApiMetricInAttributes.md) - - [JsonApiMetricInAttributesContent](docs/JsonApiMetricInAttributesContent.md) + - [JsonApiMetricInAttributesConditionalFormatting](docs/JsonApiMetricInAttributesConditionalFormatting.md) - [JsonApiMetricInDocument](docs/JsonApiMetricInDocument.md) - [JsonApiMetricLinkage](docs/JsonApiMetricLinkage.md) - [JsonApiMetricOut](docs/JsonApiMetricOut.md) - [JsonApiMetricOutAttributes](docs/JsonApiMetricOutAttributes.md) - [JsonApiMetricOutDocument](docs/JsonApiMetricOutDocument.md) - - [JsonApiMetricOutIncludes](docs/JsonApiMetricOutIncludes.md) - [JsonApiMetricOutList](docs/JsonApiMetricOutList.md) - - [JsonApiMetricOutRelationships](docs/JsonApiMetricOutRelationships.md) - [JsonApiMetricOutWithLinks](docs/JsonApiMetricOutWithLinks.md) - [JsonApiMetricPatch](docs/JsonApiMetricPatch.md) - [JsonApiMetricPatchAttributes](docs/JsonApiMetricPatchAttributes.md) @@ -2389,6 +2464,45 @@ Class | Method | HTTP request | Description - [JsonApiParameterPostOptionalId](docs/JsonApiParameterPostOptionalId.md) - [JsonApiParameterPostOptionalIdDocument](docs/JsonApiParameterPostOptionalIdDocument.md) - [JsonApiParameterToManyLinkage](docs/JsonApiParameterToManyLinkage.md) + - [JsonApiReportIn](docs/JsonApiReportIn.md) + - [JsonApiReportInAttributes](docs/JsonApiReportInAttributes.md) + - [JsonApiReportInDocument](docs/JsonApiReportInDocument.md) + - [JsonApiReportOut](docs/JsonApiReportOut.md) + - [JsonApiReportOutAttributes](docs/JsonApiReportOutAttributes.md) + - [JsonApiReportOutDocument](docs/JsonApiReportOutDocument.md) + - [JsonApiReportOutList](docs/JsonApiReportOutList.md) + - [JsonApiReportOutWithLinks](docs/JsonApiReportOutWithLinks.md) + - [JsonApiReportPageLayoutIn](docs/JsonApiReportPageLayoutIn.md) + - [JsonApiReportPageLayoutInAttributes](docs/JsonApiReportPageLayoutInAttributes.md) + - [JsonApiReportPageLayoutInDocument](docs/JsonApiReportPageLayoutInDocument.md) + - [JsonApiReportPageLayoutOut](docs/JsonApiReportPageLayoutOut.md) + - [JsonApiReportPageLayoutOutAttributes](docs/JsonApiReportPageLayoutOutAttributes.md) + - [JsonApiReportPageLayoutOutDocument](docs/JsonApiReportPageLayoutOutDocument.md) + - [JsonApiReportPageLayoutOutList](docs/JsonApiReportPageLayoutOutList.md) + - [JsonApiReportPageLayoutOutWithLinks](docs/JsonApiReportPageLayoutOutWithLinks.md) + - [JsonApiReportPageLayoutPatch](docs/JsonApiReportPageLayoutPatch.md) + - [JsonApiReportPageLayoutPatchAttributes](docs/JsonApiReportPageLayoutPatchAttributes.md) + - [JsonApiReportPageLayoutPatchDocument](docs/JsonApiReportPageLayoutPatchDocument.md) + - [JsonApiReportPageLayoutPostOptionalId](docs/JsonApiReportPageLayoutPostOptionalId.md) + - [JsonApiReportPageLayoutPostOptionalIdDocument](docs/JsonApiReportPageLayoutPostOptionalIdDocument.md) + - [JsonApiReportPatch](docs/JsonApiReportPatch.md) + - [JsonApiReportPatchAttributes](docs/JsonApiReportPatchAttributes.md) + - [JsonApiReportPatchDocument](docs/JsonApiReportPatchDocument.md) + - [JsonApiReportPostOptionalId](docs/JsonApiReportPostOptionalId.md) + - [JsonApiReportPostOptionalIdDocument](docs/JsonApiReportPostOptionalIdDocument.md) + - [JsonApiReportTemplateIn](docs/JsonApiReportTemplateIn.md) + - [JsonApiReportTemplateInAttributes](docs/JsonApiReportTemplateInAttributes.md) + - [JsonApiReportTemplateInDocument](docs/JsonApiReportTemplateInDocument.md) + - [JsonApiReportTemplateOut](docs/JsonApiReportTemplateOut.md) + - [JsonApiReportTemplateOutAttributes](docs/JsonApiReportTemplateOutAttributes.md) + - [JsonApiReportTemplateOutDocument](docs/JsonApiReportTemplateOutDocument.md) + - [JsonApiReportTemplateOutList](docs/JsonApiReportTemplateOutList.md) + - [JsonApiReportTemplateOutWithLinks](docs/JsonApiReportTemplateOutWithLinks.md) + - [JsonApiReportTemplatePatch](docs/JsonApiReportTemplatePatch.md) + - [JsonApiReportTemplatePatchAttributes](docs/JsonApiReportTemplatePatchAttributes.md) + - [JsonApiReportTemplatePatchDocument](docs/JsonApiReportTemplatePatchDocument.md) + - [JsonApiReportTemplatePostOptionalId](docs/JsonApiReportTemplatePostOptionalId.md) + - [JsonApiReportTemplatePostOptionalIdDocument](docs/JsonApiReportTemplatePostOptionalIdDocument.md) - [JsonApiThemeIn](docs/JsonApiThemeIn.md) - [JsonApiThemeInDocument](docs/JsonApiThemeInDocument.md) - [JsonApiThemeOut](docs/JsonApiThemeOut.md) @@ -2443,6 +2557,7 @@ Class | Method | HTTP request | Description - [JsonApiUserPatch](docs/JsonApiUserPatch.md) - [JsonApiUserPatchDocument](docs/JsonApiUserPatchDocument.md) - [JsonApiUserSettingIn](docs/JsonApiUserSettingIn.md) + - [JsonApiUserSettingInAttributes](docs/JsonApiUserSettingInAttributes.md) - [JsonApiUserSettingInDocument](docs/JsonApiUserSettingInDocument.md) - [JsonApiUserSettingOut](docs/JsonApiUserSettingOut.md) - [JsonApiUserSettingOutDocument](docs/JsonApiUserSettingOutDocument.md) @@ -2452,6 +2567,7 @@ Class | Method | HTTP request | Description - [JsonApiUserToOneLinkage](docs/JsonApiUserToOneLinkage.md) - [JsonApiVisualizationObjectIn](docs/JsonApiVisualizationObjectIn.md) - [JsonApiVisualizationObjectInAttributes](docs/JsonApiVisualizationObjectInAttributes.md) + - [JsonApiVisualizationObjectInAttributesConditionalFormatting](docs/JsonApiVisualizationObjectInAttributesConditionalFormatting.md) - [JsonApiVisualizationObjectInDocument](docs/JsonApiVisualizationObjectInDocument.md) - [JsonApiVisualizationObjectLinkage](docs/JsonApiVisualizationObjectLinkage.md) - [JsonApiVisualizationObjectOut](docs/JsonApiVisualizationObjectOut.md) @@ -2559,7 +2675,6 @@ Class | Method | HTTP request | Description - [JsonApiWorkspaceThemePatchDocument](docs/JsonApiWorkspaceThemePatchDocument.md) - [JsonApiWorkspaceToOneLinkage](docs/JsonApiWorkspaceToOneLinkage.md) - [JsonNode](docs/JsonNode.md) - - [KeyConfig](docs/KeyConfig.md) - [KeyDriversDimension](docs/KeyDriversDimension.md) - [KeyDriversRequest](docs/KeyDriversRequest.md) - [KeyDriversResponse](docs/KeyDriversResponse.md) @@ -2581,10 +2696,12 @@ Class | Method | HTTP request | Description - [LocalIdentifier](docs/LocalIdentifier.md) - [LocaleRequest](docs/LocaleRequest.md) - [ManageAttributePermissionsRequestInner](docs/ManageAttributePermissionsRequestInner.md) + - [ManageComputedAttributePermissionsRequestInner](docs/ManageComputedAttributePermissionsRequestInner.md) - [ManageDashboardPermissionsRequestInner](docs/ManageDashboardPermissionsRequestInner.md) - [ManageFactPermissionsRequestInner](docs/ManageFactPermissionsRequestInner.md) - [ManageLabelPermissionsRequestInner](docs/ManageLabelPermissionsRequestInner.md) - [ManageMetricPermissionsRequestInner](docs/ManageMetricPermissionsRequestInner.md) + - [ManageVisualizationPermissionsRequestInner](docs/ManageVisualizationPermissionsRequestInner.md) - [MatchAttributeFilter](docs/MatchAttributeFilter.md) - [MatchAttributeFilterMatchAttributeFilter](docs/MatchAttributeFilterMatchAttributeFilter.md) - [MatomoService](docs/MatomoService.md) @@ -2598,7 +2715,6 @@ Class | Method | HTTP request | Description - [MeasureValueFilter](docs/MeasureValueFilter.md) - [MemoryItemCreatedByUsers](docs/MemoryItemCreatedByUsers.md) - [MemoryItemUser](docs/MemoryItemUser.md) - - [Metric](docs/Metric.md) - [MetricDefinitionOverride](docs/MetricDefinitionOverride.md) - [MetricPermissions](docs/MetricPermissions.md) - [MetricPermissionsAssignment](docs/MetricPermissionsAssignment.md) @@ -2622,10 +2738,9 @@ Class | Method | HTTP request | Description - [NotificationsMetaTotal](docs/NotificationsMetaTotal.md) - [NumberConstraints](docs/NumberConstraints.md) - [NumberParameterDefinition](docs/NumberParameterDefinition.md) + - [ObjectConditionalFormatting](docs/ObjectConditionalFormatting.md) - [ObjectLinks](docs/ObjectLinks.md) - [ObjectLinksContainer](docs/ObjectLinksContainer.md) - - [ObjectReference](docs/ObjectReference.md) - - [ObjectReferenceGroup](docs/ObjectReferenceGroup.md) - [ObjectStorageInfo](docs/ObjectStorageInfo.md) - [OpenAIProviderConfig](docs/OpenAIProviderConfig.md) - [OpenAiApiKeyAuth](docs/OpenAiApiKeyAuth.md) @@ -2650,7 +2765,6 @@ Class | Method | HTTP request | Description - [ParameterDefinition](docs/ParameterDefinition.md) - [ParameterItem](docs/ParameterItem.md) - [ParameterValue](docs/ParameterValue.md) - - [PartitionConfig](docs/PartitionConfig.md) - [PdfTableStyle](docs/PdfTableStyle.md) - [PdfTableStyleProperty](docs/PdfTableStyleProperty.md) - [PdmLdmRequest](docs/PdmLdmRequest.md) @@ -2659,8 +2773,6 @@ Class | Method | HTTP request | Description - [PermissionsAssignment](docs/PermissionsAssignment.md) - [PermissionsForAssignee](docs/PermissionsForAssignee.md) - [PermissionsForAssigneeRule](docs/PermissionsForAssigneeRule.md) - - [PipeTable](docs/PipeTable.md) - - [PipeTableSummary](docs/PipeTableSummary.md) - [PlatformUsage](docs/PlatformUsage.md) - [PlatformUsageRequest](docs/PlatformUsageRequest.md) - [PopDataset](docs/PopDataset.md) @@ -2672,7 +2784,6 @@ Class | Method | HTTP request | Description - [PopMeasureDefinition](docs/PopMeasureDefinition.md) - [PositiveAttributeFilter](docs/PositiveAttributeFilter.md) - [PositiveAttributeFilterPositiveAttributeFilter](docs/PositiveAttributeFilterPositiveAttributeFilter.md) - - [PrimaryKeyConfig](docs/PrimaryKeyConfig.md) - [Profile](docs/Profile.md) - [ProfileFeatures](docs/ProfileFeatures.md) - [ProfileLinks](docs/ProfileLinks.md) @@ -2680,7 +2791,6 @@ Class | Method | HTTP request | Description - [QualityIssue](docs/QualityIssue.md) - [QualityIssueObject](docs/QualityIssueObject.md) - [QualityIssuesCalculationStatusResponse](docs/QualityIssuesCalculationStatusResponse.md) - - [RandomDistributionConfig](docs/RandomDistributionConfig.md) - [Range](docs/Range.md) - [RangeCondition](docs/RangeCondition.md) - [RangeConditionRange](docs/RangeConditionRange.md) @@ -2697,45 +2807,32 @@ Class | Method | HTTP request | Description - [ReadCsvFileManifestsRequest](docs/ReadCsvFileManifestsRequest.md) - [ReadCsvFileManifestsRequestItem](docs/ReadCsvFileManifestsRequestItem.md) - [ReadCsvFileManifestsResponse](docs/ReadCsvFileManifestsResponse.md) - - [Reasoning](docs/Reasoning.md) - - [ReasoningStep](docs/ReasoningStep.md) - [ReferenceIdentifier](docs/ReferenceIdentifier.md) - [ReferenceSourceColumn](docs/ReferenceSourceColumn.md) - - [RefreshPartitionRequest](docs/RefreshPartitionRequest.md) - [Relative](docs/Relative.md) - [RelativeBoundedDateFilter](docs/RelativeBoundedDateFilter.md) - [RelativeDateFilter](docs/RelativeDateFilter.md) - [RelativeDateFilterRelativeDateFilter](docs/RelativeDateFilterRelativeDateFilter.md) - [RelativeWrapper](docs/RelativeWrapper.md) - [RemoveDatabaseDataSourceResponse](docs/RemoveDatabaseDataSourceResponse.md) + - [ReportExportRequest](docs/ReportExportRequest.md) - [ResolveSettingsRequest](docs/ResolveSettingsRequest.md) - - [ResolvedLlm](docs/ResolvedLlm.md) - - [ResolvedLlmProvider](docs/ResolvedLlmProvider.md) - - [ResolvedLlmProviderAllOf](docs/ResolvedLlmProviderAllOf.md) - - [ResolvedLlms](docs/ResolvedLlms.md) - - [ResolvedLlmsData](docs/ResolvedLlmsData.md) - [ResolvedSetting](docs/ResolvedSetting.md) - [RestApiIdentifier](docs/RestApiIdentifier.md) + - [RestrictedObject](docs/RestrictedObject.md) - [ResultCacheMetadata](docs/ResultCacheMetadata.md) - [ResultDimension](docs/ResultDimension.md) - [ResultDimensionHeader](docs/ResultDimensionHeader.md) - [ResultSpec](docs/ResultSpec.md) - - [RichTextWidgetDescriptor](docs/RichTextWidgetDescriptor.md) - - [RouteResult](docs/RouteResult.md) - [RsaSpecification](docs/RsaSpecification.md) - [RulePermission](docs/RulePermission.md) - [RunServiceCommandRequest](docs/RunServiceCommandRequest.md) - [RunningSection](docs/RunningSection.md) - - [SavedVisualization](docs/SavedVisualization.md) - [ScanRequest](docs/ScanRequest.md) - [ScanResultPdm](docs/ScanResultPdm.md) - [ScanSqlRequest](docs/ScanSqlRequest.md) - [ScanSqlResponse](docs/ScanSqlResponse.md) - [ScheduleCacheRetention](docs/ScheduleCacheRetention.md) - - [SearchRelationshipObject](docs/SearchRelationshipObject.md) - - [SearchRequest](docs/SearchRequest.md) - - [SearchResult](docs/SearchResult.md) - - [SearchResultObject](docs/SearchResultObject.md) - [SectionSlideTemplate](docs/SectionSlideTemplate.md) - [ServiceInfo](docs/ServiceInfo.md) - [SetCertificationRequest](docs/SetCertificationRequest.md) @@ -2756,6 +2853,8 @@ Class | Method | HTTP request | Description - [SortKeyValueValue](docs/SortKeyValueValue.md) - [SourceReferenceIdentifier](docs/SourceReferenceIdentifier.md) - [SqlColumn](docs/SqlColumn.md) + - [SqlFlowInput](docs/SqlFlowInput.md) + - [SqlFlowInputAllOf](docs/SqlFlowInputAllOf.md) - [SqlQuery](docs/SqlQuery.md) - [SqlQueryAllOf](docs/SqlQueryAllOf.md) - [StaticFeatures](docs/StaticFeatures.md) @@ -2765,7 +2864,6 @@ Class | Method | HTTP request | Description - [StringParameterDefinition](docs/StringParameterDefinition.md) - [SucceededOperation](docs/SucceededOperation.md) - [SucceededOperationAllOf](docs/SucceededOperationAllOf.md) - - [Suggestion](docs/Suggestion.md) - [SwitchIdentityProviderRequest](docs/SwitchIdentityProviderRequest.md) - [Table](docs/Table.md) - [TableAllOf](docs/TableAllOf.md) @@ -2790,8 +2888,6 @@ Class | Method | HTTP request | Description - [TestQueryDuration](docs/TestQueryDuration.md) - [TestRequest](docs/TestRequest.md) - [TestResponse](docs/TestResponse.md) - - [Thought](docs/Thought.md) - - [TimeSlicePartitionConfig](docs/TimeSlicePartitionConfig.md) - [Total](docs/Total.md) - [TotalDimension](docs/TotalDimension.md) - [TotalExecutionResultHeader](docs/TotalExecutionResultHeader.md) @@ -2800,14 +2896,11 @@ Class | Method | HTTP request | Description - [TrendingObjectsResult](docs/TrendingObjectsResult.md) - [TriggerAutomationRequest](docs/TriggerAutomationRequest.md) - [TriggerQualityIssuesCalculationResponse](docs/TriggerQualityIssuesCalculationResponse.md) - - [UIContext](docs/UIContext.md) - - [UniqueKeyConfig](docs/UniqueKeyConfig.md) - [UpdateDatabaseDataSourceRequest](docs/UpdateDatabaseDataSourceRequest.md) - [UpdateDatabaseDataSourceResponse](docs/UpdateDatabaseDataSourceResponse.md) - [UploadFileResponse](docs/UploadFileResponse.md) - [UploadGeoCollectionFileResponse](docs/UploadGeoCollectionFileResponse.md) - [UserAssignee](docs/UserAssignee.md) - - [UserContext](docs/UserContext.md) - [UserGroupAssignee](docs/UserGroupAssignee.md) - [UserGroupIdentifier](docs/UserGroupIdentifier.md) - [UserGroupPermission](docs/UserGroupPermission.md) @@ -2826,23 +2919,18 @@ Class | Method | HTTP request | Description - [Value](docs/Value.md) - [VisibleFilter](docs/VisibleFilter.md) - [VisualExportRequest](docs/VisualExportRequest.md) - - [VisualizationConfig](docs/VisualizationConfig.md) - [VisualizationObjectExecution](docs/VisualizationObjectExecution.md) - - [VisualizationSwitcherWidgetDescriptor](docs/VisualizationSwitcherWidgetDescriptor.md) + - [VisualizationPermissions](docs/VisualizationPermissions.md) + - [VisualizationPermissionsAssignment](docs/VisualizationPermissionsAssignment.md) + - [VisualizationPermissionsForAssignee](docs/VisualizationPermissionsForAssignee.md) + - [VisualizationPermissionsForAssigneeRule](docs/VisualizationPermissionsForAssigneeRule.md) - [Webhook](docs/Webhook.md) - [WebhookAllOf](docs/WebhookAllOf.md) - [WebhookAutomationInfo](docs/WebhookAutomationInfo.md) - [WebhookMessage](docs/WebhookMessage.md) - [WebhookMessageData](docs/WebhookMessageData.md) - [WebhookRecipient](docs/WebhookRecipient.md) - - [WhatIfMeasureAdjustmentConfig](docs/WhatIfMeasureAdjustmentConfig.md) - - [WhatIfScenarioConfig](docs/WhatIfScenarioConfig.md) - - [WhatIfScenarioItem](docs/WhatIfScenarioItem.md) - - [WidgetDescriptor](docs/WidgetDescriptor.md) - [WidgetSlidesTemplate](docs/WidgetSlidesTemplate.md) - - [WorkflowDashboardSummaryRequestDto](docs/WorkflowDashboardSummaryRequestDto.md) - - [WorkflowDashboardSummaryResponseDto](docs/WorkflowDashboardSummaryResponseDto.md) - - [WorkflowStatusResponseDto](docs/WorkflowStatusResponseDto.md) - [WorkspaceAutomationIdentifier](docs/WorkspaceAutomationIdentifier.md) - [WorkspaceAutomationManagementBulkRequest](docs/WorkspaceAutomationManagementBulkRequest.md) - [WorkspaceCacheSettings](docs/WorkspaceCacheSettings.md) diff --git a/gooddata-api-client/docs/AILakeApi.md b/gooddata-api-client/docs/AILakeApi.md index a7e18cffa..c7ee88978 100644 --- a/gooddata-api-client/docs/AILakeApi.md +++ b/gooddata-api-client/docs/AILakeApi.md @@ -6,20 +6,15 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**add_ai_lake_database_data_source**](AILakeApi.md#add_ai_lake_database_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) Add a data source to an AILake Database instance [**analyze_statistics**](AILakeApi.md#analyze_statistics) | **POST** /api/v1/ailake/database/instances/{instanceId}/analyzeStatistics | (BETA) Run ANALYZE TABLE for tables in a database instance -[**create_ai_lake_pipe_table**](AILakeApi.md#create_ai_lake_pipe_table) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) Create a new AI Lake pipe table -[**delete_ai_lake_pipe_table**](AILakeApi.md#delete_ai_lake_pipe_table) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Delete an AI Lake pipe table [**deprovision_ai_lake_database_instance**](AILakeApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance [**get_ai_lake_database_instance**](AILakeApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance [**get_ai_lake_operation**](AILakeApi.md#get_ai_lake_operation) | **GET** /api/v1/ailake/operations/{operationId} | (BETA) Get Long Running Operation details -[**get_ai_lake_pipe_table**](AILakeApi.md#get_ai_lake_pipe_table) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Get an AI Lake pipe table [**get_ai_lake_service_status**](AILakeApi.md#get_ai_lake_service_status) | **GET** /api/v1/ailake/services/{serviceId}/status | (BETA) Get AI Lake service status [**list_ai_lake_database_data_sources**](AILakeApi.md#list_ai_lake_database_data_sources) | **GET** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) List data sources of an AILake Database instance [**list_ai_lake_database_instances**](AILakeApi.md#list_ai_lake_database_instances) | **GET** /api/v1/ailake/database/instances | (BETA) List AI Lake Database instances [**list_ai_lake_object_storages**](AILakeApi.md#list_ai_lake_object_storages) | **GET** /api/v1/ailake/objectStorages | (BETA) List registered AI Lake ObjectStorages -[**list_ai_lake_pipe_tables**](AILakeApi.md#list_ai_lake_pipe_tables) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) List AI Lake pipe tables [**list_ai_lake_services**](AILakeApi.md#list_ai_lake_services) | **GET** /api/v1/ailake/services | (BETA) List AI Lake services [**provision_ai_lake_database_instance**](AILakeApi.md#provision_ai_lake_database_instance) | **POST** /api/v1/ailake/database/instances | (BETA) Create a new AILake Database instance -[**refresh_ai_lake_pipe_table_partition**](AILakeApi.md#refresh_ai_lake_pipe_table_partition) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh | (BETA) Refresh a pipe table partition [**remove_ai_lake_database_data_source**](AILakeApi.md#remove_ai_lake_database_data_source) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId} | (BETA) Remove a data source from an AILake Database instance [**run_ai_lake_service_command**](AILakeApi.md#run_ai_lake_service_command) | **POST** /api/v1/ailake/services/{serviceId}/commands/{commandName}/run | (BETA) Run an AI Lake services command [**update_ai_lake_database_data_source**](AILakeApi.md#update_ai_lake_database_data_source) | **PATCH** /api/v1/ailake/database/instances/{instanceId}/dataSource | (BETA) Update the data source of an AILake Database instance @@ -103,7 +98,7 @@ No authorization required (BETA) Run ANALYZE TABLE for tables in a database instance -(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. +(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. ### Example @@ -176,186 +171,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**202** | Statistics analysis scheduled. | * operation-id -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_ai_lake_pipe_table** -> create_ai_lake_pipe_table(instance_id, create_pipe_table_request) - -(BETA) Create a new AI Lake pipe table - -(BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_api -from gooddata_api_client.model.create_pipe_table_request import CreatePipeTableRequest -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_api.AILakeApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - create_pipe_table_request = CreatePipeTableRequest( - aggregation_overrides={ - "key": "key_example", - }, - column_expressions={ - "key": ColumnExpression( - column="column_example", - function="HLL_HASH", - ), - }, - column_overrides={ - "key": "key_example", - }, - distribution_config=CreatePipeTableRequestDistributionConfig(None), - key_config=CreatePipeTableRequestKeyConfig(None), - max_varchar_length=1, - partition_config=CreatePipeTableRequestPartitionConfig(None), - path_prefix="path_prefix_example", - polling_interval_seconds=1, - source_storage_name="source_storage_name_example", - table_name="table_name_example", - table_properties={ - "key": "key_example", - }, - ) # CreatePipeTableRequest | - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Create a new AI Lake pipe table - api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->create_ai_lake_pipe_table: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Create a new AI Lake pipe table - api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->create_ai_lake_pipe_table: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **create_pipe_table_request** | [**CreatePipeTableRequest**](CreatePipeTableRequest.md)| | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Accepted | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_ai_lake_pipe_table** -> delete_ai_lake_pipe_table(instance_id, table_name) - -(BETA) Delete an AI Lake pipe table - -(BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_api -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_api.AILakeApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - table_name = "tableName_example" # str | Pipe table name. - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Delete an AI Lake pipe table - api_instance.delete_ai_lake_pipe_table(instance_id, table_name) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->delete_ai_lake_pipe_table: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Delete an AI Lake pipe table - api_instance.delete_ai_lake_pipe_table(instance_id, table_name, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->delete_ai_lake_pipe_table: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **table_name** | **str**| Pipe table name. | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Accepted | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| +**202** | Statistics analysis scheduled. | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -364,7 +180,7 @@ No authorization required (BETA) Delete an existing AILake Database instance -(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress. +(BETA) Deletes an existing database in the organization's AI Lake. A database that still contains tables is not deleted, unless cascade is set. With cascade, every table in the database is dropped first, which cannot be undone. Returns an operation-id in the operation-id header the client can use to poll for the progress. ### Example @@ -386,6 +202,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_api.AILakeApi(api_client) instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. + cascade = True # bool | Drop every table in the database before the database itself. (optional) operation_id = "operation-id_example" # str | (optional) # example passing only required values which don't have defaults set @@ -399,7 +216,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Delete an existing AILake Database instance - api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) + api_instance.deprovision_ai_lake_database_instance(instance_id, cascade=cascade, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeApi->deprovision_ai_lake_database_instance: %s\n" % e) ``` @@ -410,6 +227,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | + **cascade** | **bool**| Drop every table in the database before the database itself. | [optional] **operation_id** | **str**| | [optional] ### Return type @@ -568,75 +386,6 @@ 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_ai_lake_pipe_table** -> JsonApiDocumentPipeTable get_ai_lake_pipe_table(instance_id, table_name) - -(BETA) Get an AI Lake pipe table - -(BETA) Returns full details of the specified pipe table. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_api -from gooddata_api_client.model.json_api_document_pipe_table import JsonApiDocumentPipeTable -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_api.AILakeApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - table_name = "tableName_example" # str | Pipe table name. - - # example passing only required values which don't have defaults set - try: - # (BETA) Get an AI Lake pipe table - api_response = api_instance.get_ai_lake_pipe_table(instance_id, table_name) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->get_ai_lake_pipe_table: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **table_name** | **str**| Pipe table name. | - -### Return type - -[**JsonApiDocumentPipeTable**](JsonApiDocumentPipeTable.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | AI Lake pipe table successfully retrieved | - | - -[[Back to top]](#) [[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_ai_lake_service_status** > GetServiceStatusResponse get_ai_lake_service_status(service_id) @@ -867,7 +616,7 @@ No authorization required (BETA) List registered AI Lake ObjectStorages -(BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. +(BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. ### Example @@ -936,90 +685,6 @@ 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) -# **list_ai_lake_pipe_tables** -> JsonApiListDocumentPipeTableSummary list_ai_lake_pipe_tables(instance_id) - -(BETA) List AI Lake pipe tables - -(BETA) Lists active pipe tables in the given AI Lake database instance. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_api -from gooddata_api_client.model.json_api_list_document_pipe_table_summary import JsonApiListDocumentPipeTableSummary -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_api.AILakeApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 - size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 - meta_include = [ - "metaInclude_example", - ] # [str] | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) List AI Lake pipe tables - api_response = api_instance.list_ai_lake_pipe_tables(instance_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->list_ai_lake_pipe_tables: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) List AI Lake pipe tables - api_response = api_instance.list_ai_lake_pipe_tables(instance_id, page=page, size=size, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->list_ai_lake_pipe_tables: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 - **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 - **meta_include** | **[str]**| | [optional] - -### Return type - -[**JsonApiListDocumentPipeTableSummary**](JsonApiListDocumentPipeTableSummary.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | AI Lake pipe tables successfully retrieved | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **list_ai_lake_services** > JsonApiListDocumentServiceInfo list_ai_lake_services() @@ -1169,90 +834,6 @@ No authorization required - **Accept**: Not defined -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Accepted | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **refresh_ai_lake_pipe_table_partition** -> refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) - -(BETA) Refresh a pipe table partition - -(BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_api -from gooddata_api_client.model.refresh_partition_request import RefreshPartitionRequest -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_api.AILakeApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - table_name = "tableName_example" # str | Pipe table name. - refresh_partition_request = RefreshPartitionRequest( - partition_spec={ - "key": "key_example", - }, - ) # RefreshPartitionRequest | - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Refresh a pipe table partition - api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Refresh a pipe table partition - api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakeApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **table_name** | **str**| Pipe table name. | - **refresh_partition_request** | [**RefreshPartitionRequest**](RefreshPartitionRequest.md)| | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - ### HTTP response details | Status code | Description | Response headers | diff --git a/gooddata-api-client/docs/AILakeDatabasesApi.md b/gooddata-api-client/docs/AILakeDatabasesApi.md index 3a51b3d01..694ce0344 100644 --- a/gooddata-api-client/docs/AILakeDatabasesApi.md +++ b/gooddata-api-client/docs/AILakeDatabasesApi.md @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_ai_lake_database_data_source**](AILakeDatabasesApi.md#add_ai_lake_database_data_source) | **POST** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) Add a data source to an AILake Database instance +[**analyze_statistics**](AILakeDatabasesApi.md#analyze_statistics) | **POST** /api/v1/ailake/database/instances/{instanceId}/analyzeStatistics | (BETA) Run ANALYZE TABLE for tables in a database instance [**deprovision_ai_lake_database_instance**](AILakeDatabasesApi.md#deprovision_ai_lake_database_instance) | **DELETE** /api/v1/ailake/database/instances/{instanceId} | (BETA) Delete an existing AILake Database instance [**get_ai_lake_database_instance**](AILakeDatabasesApi.md#get_ai_lake_database_instance) | **GET** /api/v1/ailake/database/instances/{instanceId} | (BETA) Get the specified AILake Database instance [**list_ai_lake_database_data_sources**](AILakeDatabasesApi.md#list_ai_lake_database_data_sources) | **GET** /api/v1/ailake/database/instances/{instanceId}/dataSources | (BETA) List data sources of an AILake Database instance @@ -88,12 +89,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) +# **analyze_statistics** +> analyze_statistics(instance_id, analyze_statistics_request) + +(BETA) Run ANALYZE TABLE for tables in a database instance + +(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import ai_lake_databases_api +from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) + instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. + analyze_statistics_request = AnalyzeStatisticsRequest( + table_names=[ + "table_names_example", + ], + ) # AnalyzeStatisticsRequest | + operation_id = "operation-id_example" # str | (optional) + + # example passing only required values which don't have defaults set + try: + # (BETA) Run ANALYZE TABLE for tables in a database instance + api_instance.analyze_statistics(instance_id, analyze_statistics_request) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeDatabasesApi->analyze_statistics: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (BETA) Run ANALYZE TABLE for tables in a database instance + api_instance.analyze_statistics(instance_id, analyze_statistics_request, operation_id=operation_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling AILakeDatabasesApi->analyze_statistics: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | + **analyze_statistics_request** | [**AnalyzeStatisticsRequest**](AnalyzeStatisticsRequest.md)| | + **operation_id** | **str**| | [optional] + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**202** | Statistics analysis scheduled. | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **deprovision_ai_lake_database_instance** > deprovision_ai_lake_database_instance(instance_id) (BETA) Delete an existing AILake Database instance -(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress. +(BETA) Deletes an existing database in the organization's AI Lake. A database that still contains tables is not deleted, unless cascade is set. With cascade, every table in the database is dropped first, which cannot be undone. Returns an operation-id in the operation-id header the client can use to poll for the progress. ### Example @@ -115,6 +198,7 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = ai_lake_databases_api.AILakeDatabasesApi(api_client) instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. + cascade = True # bool | Drop every table in the database before the database itself. (optional) operation_id = "operation-id_example" # str | (optional) # example passing only required values which don't have defaults set @@ -128,7 +212,7 @@ with gooddata_api_client.ApiClient() as api_client: # and optional values try: # (BETA) Delete an existing AILake Database instance - api_instance.deprovision_ai_lake_database_instance(instance_id, operation_id=operation_id) + api_instance.deprovision_ai_lake_database_instance(instance_id, cascade=cascade, operation_id=operation_id) except gooddata_api_client.ApiException as e: print("Exception when calling AILakeDatabasesApi->deprovision_ai_lake_database_instance: %s\n" % e) ``` @@ -139,6 +223,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | + **cascade** | **bool**| Drop every table in the database before the database itself. | [optional] **operation_id** | **str**| | [optional] ### Return type @@ -393,7 +478,7 @@ No authorization required (BETA) List registered AI Lake ObjectStorages -(BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. +(BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. ### Example diff --git a/gooddata-api-client/docs/AILakePipeTablesApi.md b/gooddata-api-client/docs/AILakePipeTablesApi.md deleted file mode 100644 index dc35587e0..000000000 --- a/gooddata-api-client/docs/AILakePipeTablesApi.md +++ /dev/null @@ -1,512 +0,0 @@ -# gooddata_api_client.AILakePipeTablesApi - -All URIs are relative to *http://localhost* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**analyze_statistics**](AILakePipeTablesApi.md#analyze_statistics) | **POST** /api/v1/ailake/database/instances/{instanceId}/analyzeStatistics | (BETA) Run ANALYZE TABLE for tables in a database instance -[**create_ai_lake_pipe_table**](AILakePipeTablesApi.md#create_ai_lake_pipe_table) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) Create a new AI Lake pipe table -[**delete_ai_lake_pipe_table**](AILakePipeTablesApi.md#delete_ai_lake_pipe_table) | **DELETE** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Delete an AI Lake pipe table -[**get_ai_lake_pipe_table**](AILakePipeTablesApi.md#get_ai_lake_pipe_table) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName} | (BETA) Get an AI Lake pipe table -[**list_ai_lake_pipe_tables**](AILakePipeTablesApi.md#list_ai_lake_pipe_tables) | **GET** /api/v1/ailake/database/instances/{instanceId}/pipeTables | (BETA) List AI Lake pipe tables -[**refresh_ai_lake_pipe_table_partition**](AILakePipeTablesApi.md#refresh_ai_lake_pipe_table_partition) | **POST** /api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh | (BETA) Refresh a pipe table partition - - -# **analyze_statistics** -> analyze_statistics(instance_id, analyze_statistics_request) - -(BETA) Run ANALYZE TABLE for tables in a database instance - -(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_pipe_tables_api -from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - analyze_statistics_request = AnalyzeStatisticsRequest( - table_names=[ - "table_names_example", - ], - ) # AnalyzeStatisticsRequest | - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Run ANALYZE TABLE for tables in a database instance - api_instance.analyze_statistics(instance_id, analyze_statistics_request) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->analyze_statistics: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Run ANALYZE TABLE for tables in a database instance - api_instance.analyze_statistics(instance_id, analyze_statistics_request, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->analyze_statistics: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **analyze_statistics_request** | [**AnalyzeStatisticsRequest**](AnalyzeStatisticsRequest.md)| | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Statistics analysis scheduled. | * operation-id -
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **create_ai_lake_pipe_table** -> create_ai_lake_pipe_table(instance_id, create_pipe_table_request) - -(BETA) Create a new AI Lake pipe table - -(BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_pipe_tables_api -from gooddata_api_client.model.create_pipe_table_request import CreatePipeTableRequest -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - create_pipe_table_request = CreatePipeTableRequest( - aggregation_overrides={ - "key": "key_example", - }, - column_expressions={ - "key": ColumnExpression( - column="column_example", - function="HLL_HASH", - ), - }, - column_overrides={ - "key": "key_example", - }, - distribution_config=CreatePipeTableRequestDistributionConfig(None), - key_config=CreatePipeTableRequestKeyConfig(None), - max_varchar_length=1, - partition_config=CreatePipeTableRequestPartitionConfig(None), - path_prefix="path_prefix_example", - polling_interval_seconds=1, - source_storage_name="source_storage_name_example", - table_name="table_name_example", - table_properties={ - "key": "key_example", - }, - ) # CreatePipeTableRequest | - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Create a new AI Lake pipe table - api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->create_ai_lake_pipe_table: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Create a new AI Lake pipe table - api_instance.create_ai_lake_pipe_table(instance_id, create_pipe_table_request, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->create_ai_lake_pipe_table: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **create_pipe_table_request** | [**CreatePipeTableRequest**](CreatePipeTableRequest.md)| | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Accepted | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **delete_ai_lake_pipe_table** -> delete_ai_lake_pipe_table(instance_id, table_name) - -(BETA) Delete an AI Lake pipe table - -(BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_pipe_tables_api -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - table_name = "tableName_example" # str | Pipe table name. - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Delete an AI Lake pipe table - api_instance.delete_ai_lake_pipe_table(instance_id, table_name) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->delete_ai_lake_pipe_table: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Delete an AI Lake pipe table - api_instance.delete_ai_lake_pipe_table(instance_id, table_name, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->delete_ai_lake_pipe_table: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **table_name** | **str**| Pipe table name. | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Accepted | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **get_ai_lake_pipe_table** -> JsonApiDocumentPipeTable get_ai_lake_pipe_table(instance_id, table_name) - -(BETA) Get an AI Lake pipe table - -(BETA) Returns full details of the specified pipe table. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_pipe_tables_api -from gooddata_api_client.model.json_api_document_pipe_table import JsonApiDocumentPipeTable -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - table_name = "tableName_example" # str | Pipe table name. - - # example passing only required values which don't have defaults set - try: - # (BETA) Get an AI Lake pipe table - api_response = api_instance.get_ai_lake_pipe_table(instance_id, table_name) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->get_ai_lake_pipe_table: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **table_name** | **str**| Pipe table name. | - -### Return type - -[**JsonApiDocumentPipeTable**](JsonApiDocumentPipeTable.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | AI Lake pipe table successfully retrieved | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **list_ai_lake_pipe_tables** -> JsonApiListDocumentPipeTableSummary list_ai_lake_pipe_tables(instance_id) - -(BETA) List AI Lake pipe tables - -(BETA) Lists active pipe tables in the given AI Lake database instance. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_pipe_tables_api -from gooddata_api_client.model.json_api_list_document_pipe_table_summary import JsonApiListDocumentPipeTableSummary -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - page = 0 # int | Zero-based page number. (optional) if omitted the server will use the default value of 0 - size = 50 # int | Number of items per page. (optional) if omitted the server will use the default value of 50 - meta_include = [ - "metaInclude_example", - ] # [str] | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) List AI Lake pipe tables - api_response = api_instance.list_ai_lake_pipe_tables(instance_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->list_ai_lake_pipe_tables: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) List AI Lake pipe tables - api_response = api_instance.list_ai_lake_pipe_tables(instance_id, page=page, size=size, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->list_ai_lake_pipe_tables: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **page** | **int**| Zero-based page number. | [optional] if omitted the server will use the default value of 0 - **size** | **int**| Number of items per page. | [optional] if omitted the server will use the default value of 50 - **meta_include** | **[str]**| | [optional] - -### Return type - -[**JsonApiListDocumentPipeTableSummary**](JsonApiListDocumentPipeTableSummary.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | AI Lake pipe tables successfully retrieved | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **refresh_ai_lake_pipe_table_partition** -> refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) - -(BETA) Refresh a pipe table partition - -(BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_lake_pipe_tables_api -from gooddata_api_client.model.refresh_partition_request import RefreshPartitionRequest -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_lake_pipe_tables_api.AILakePipeTablesApi(api_client) - instance_id = "instanceId_example" # str | Database instance identifier. Accepts the database name (preferred) or UUID. - table_name = "tableName_example" # str | Pipe table name. - refresh_partition_request = RefreshPartitionRequest( - partition_spec={ - "key": "key_example", - }, - ) # RefreshPartitionRequest | - operation_id = "operation-id_example" # str | (optional) - - # example passing only required values which don't have defaults set - try: - # (BETA) Refresh a pipe table partition - api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # (BETA) Refresh a pipe table partition - api_instance.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, operation_id=operation_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling AILakePipeTablesApi->refresh_ai_lake_pipe_table_partition: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **instance_id** | **str**| Database instance identifier. Accepts the database name (preferred) or UUID. | - **table_name** | **str**| Pipe table name. | - **refresh_partition_request** | [**RefreshPartitionRequest**](RefreshPartitionRequest.md)| | - **operation_id** | **str**| | [optional] - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: Not defined - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**202** | Accepted | * operation-id - Operation ID to use for polling.
* operation-location - Operation location URL that can be used for polling.
| - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/gooddata-api-client/docs/ActionsApi.md b/gooddata-api-client/docs/ActionsApi.md index 288504085..deaa7aaea 100644 --- a/gooddata-api-client/docs/ActionsApi.md +++ b/gooddata-api-client/docs/ActionsApi.md @@ -5,11 +5,10 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**add_targets**](ActionsApi.md#add_targets) | **POST** /api/v1/actions/ipAllowlistPolicies/{id}/addTargets | Add targets to IP allowlist policy -[**ai_chat**](ActionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (BETA) Chat with AI -[**ai_chat_history**](ActionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (BETA) Get Chat History -[**ai_chat_stream**](ActionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (BETA) Chat with AI -[**ai_chat_usage**](ActionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | Get Chat Usage -[**ai_search**](ActionsApi.md#ai_search) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/search | (BETA) Semantic Search in Metadata +[**ai_chat**](ActionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (REMOVED) Chat with AI +[**ai_chat_history**](ActionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (REMOVED) Get Chat History +[**ai_chat_stream**](ActionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (REMOVED) Chat with AI +[**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 [**anomaly_detection**](ActionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection @@ -17,7 +16,7 @@ Method | HTTP request | Description [**attribute_permissions**](ActionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions [**available_assignees**](ActionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees [**cancel_executions**](ActionsApi.md#cancel_executions) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel | Applies all the given cancel tokens. -[**cancel_workflow**](ActionsApi.md#cancel_workflow) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/cancel | +[**cancel_flows**](ActionsApi.md#cancel_flows) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel | (EXPERIMENTAL) Apply the given cancel tokens to flows [**change_analysis**](ActionsApi.md#change_analysis) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis | Compute change analysis [**change_analysis_result**](ActionsApi.md#change_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId} | Get change analysis result [**check_entity_overrides**](ActionsApi.md#check_entity_overrides) | **POST** /api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides | Finds entities with given ID in hierarchy. @@ -31,11 +30,13 @@ Method | HTTP request | Description [**compute_report_for_visualization_object**](ActionsApi.md#compute_report_for_visualization_object) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute | (BETA) Executes a visualization object and returns link to the result [**compute_valid_descendants**](ActionsApi.md#compute_valid_descendants) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants | (BETA) Valid descendants [**compute_valid_objects**](ActionsApi.md#compute_valid_objects) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects | Valid objects +[**computed_attribute_permissions**](ActionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions [**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_image_export**](ActionsApi.md#create_image_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/image | (EXPERIMENTAL) Create image export request [**create_pdf_export**](ActionsApi.md#create_pdf_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/visual | Create visual - pdf export request [**create_raw_export**](ActionsApi.md#create_raw_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/raw | (EXPERIMENTAL) Create raw export request +[**create_report_export**](ActionsApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request [**create_slides_export**](ActionsApi.md#create_slides_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/slides | (EXPERIMENTAL) Create slides export request [**create_tabular_export**](ActionsApi.md#create_tabular_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/tabular | Create tabular export request [**created_by**](ActionsApi.md#created_by) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy | Get Analytics Catalog CreatedBy Users @@ -44,11 +45,11 @@ Method | HTTP request | Description [**delete_files**](ActionsApi.md#delete_files) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/deleteFiles | Delete datasource files [**delete_organization_automations**](ActionsApi.md#delete_organization_automations) | **POST** /api/v1/actions/organization/automations/delete | Delete selected automations across all workspaces [**delete_workspace_automations**](ActionsApi.md#delete_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/delete | Delete selected automations in the workspace +[**execute_flow**](ActionsApi.md#execute_flow) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow | (EXPERIMENTAL) Execute a flow [**explain_afm**](ActionsApi.md#explain_afm) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/afm/explain | AFM explain resource. [**fact_permissions**](ActionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions [**forecast**](ActionsApi.md#forecast) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId} | Smart functions - Forecast [**forecast_result**](ActionsApi.md#forecast_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId} | Smart functions - Forecast Result -[**generate_dashboard_summary**](ActionsApi.md#generate_dashboard_summary) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary | [**generate_description**](ActionsApi.md#generate_description) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription | Generate Description for Analytics Object [**generate_logical_model**](ActionsApi.md#generate_logical_model) | **POST** /api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel | Generate logical data model (LDM) from physical data model (PDM) [**generate_title**](ActionsApi.md#generate_title) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle | Generate Title for Analytics Object @@ -63,11 +64,12 @@ Method | HTTP request | Description [**get_quality_issues**](ActionsApi.md#get_quality_issues) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues | Get Quality Issues [**get_quality_issues_calculation_status**](ActionsApi.md#get_quality_issues_calculation_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId} | Get Quality Issues Calculation Status [**get_raw_export**](ActionsApi.md#get_raw_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**get_report_export**](ActionsApi.md#get_report_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId} | (EXPERIMENTAL) Retrieve exported files +[**get_report_export_metadata**](ActionsApi.md#get_report_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context [**get_slides_export**](ActionsApi.md#get_slides_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId} | (EXPERIMENTAL) Retrieve exported files [**get_slides_export_metadata**](ActionsApi.md#get_slides_export_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata | (EXPERIMENTAL) Retrieve metadata context [**get_tabular_export**](ActionsApi.md#get_tabular_export) | **GET** /api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId} | Retrieve exported files [**get_translation_tags**](ActionsApi.md#get_translation_tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/translations | Get translation tags. -[**get_workflow_status**](ActionsApi.md#get_workflow_status) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/status | [**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 [**inherited_entity_conflicts**](ActionsApi.md#inherited_entity_conflicts) | **GET** /api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts | Finds identifier conflicts in workspace hierarchy. @@ -76,17 +78,20 @@ Method | HTTP request | Description [**key_driver_analysis_result**](ActionsApi.md#key_driver_analysis_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId} | (EXPERIMENTAL) Get key driver analysis result [**label_permissions**](ActionsApi.md#label_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions | Get Label Permissions [**list_files**](ActionsApi.md#list_files) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles | List datasource files +[**list_flow_operations**](ActionsApi.md#list_flow_operations) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/operations | (EXPERIMENTAL) List the operations of flows [**list_llm_provider_models**](ActionsApi.md#list_llm_provider_models) | **POST** /api/v1/actions/ai/llmProvider/listModels | List LLM Provider Models [**list_llm_provider_models_by_id**](ActionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id [**list_workspace_user_groups**](ActionsApi.md#list_workspace_user_groups) | **GET** /api/v1/actions/workspaces/{workspaceId}/userGroups | [**list_workspace_users**](ActionsApi.md#list_workspace_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/users | [**manage_attribute_permissions**](ActionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute +[**manage_computed_attribute_permissions**](ActionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute [**manage_dashboard_permissions**](ActionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard [**manage_data_source_permissions**](ActionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source [**manage_fact_permissions**](ActionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact [**manage_label_permissions**](ActionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label [**manage_metric_permissions**](ActionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric [**manage_organization_permissions**](ActionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization +[**manage_visualization_permissions**](ActionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization [**manage_workspace_permissions**](ActionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace [**mark_as_read_notification**](ActionsApi.md#mark_as_read_notification) | **POST** /api/v1/actions/notifications/{notificationId}/markAsRead | Mark notification as read. [**mark_as_read_notification_all**](ActionsApi.md#mark_as_read_notification_all) | **POST** /api/v1/actions/notifications/markAsRead | Mark all notifications as read. @@ -98,6 +103,7 @@ Method | HTTP request | Description [**particular_platform_usage**](ActionsApi.md#particular_platform_usage) | **POST** /api/v1/actions/collectUsage | Info about the platform usage for particular items. [**pause_organization_automations**](ActionsApi.md#pause_organization_automations) | **POST** /api/v1/actions/organization/automations/pause | Pause selected automations across all workspaces [**pause_workspace_automations**](ActionsApi.md#pause_workspace_automations) | **POST** /api/v1/actions/workspaces/{workspaceId}/automations/pause | Pause selected automations in the workspace +[**process_invitation**](ActionsApi.md#process_invitation) | **POST** /api/v1/actions/invite | Invite User [**read_csv_file_manifests**](ActionsApi.md#read_csv_file_manifests) | **POST** /api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests | Read CSV file manifests [**register_upload_notification**](ActionsApi.md#register_upload_notification) | **POST** /api/v1/actions/dataSources/{dataSourceId}/uploadNotification | Register an upload notification [**register_workspace_upload_notification**](ActionsApi.md#register_workspace_upload_notification) | **POST** /api/v1/actions/workspaces/{workspaceId}/uploadNotification | Register an upload notification @@ -106,20 +112,23 @@ Method | HTTP request | Description [**resolve_all_entitlements**](ActionsApi.md#resolve_all_entitlements) | **GET** /api/v1/actions/resolveEntitlements | Values for all public entitlements. [**resolve_all_settings_without_workspace**](ActionsApi.md#resolve_all_settings_without_workspace) | **GET** /api/v1/actions/resolveSettings | Values for all settings without workspace. [**resolve_llm_endpoints**](ActionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace (Removed) -[**resolve_llm_providers**](ActionsApi.md#resolve_llm_providers) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders | Get Active LLM configuration for this workspace [**resolve_requested_entitlements**](ActionsApi.md#resolve_requested_entitlements) | **POST** /api/v1/actions/resolveEntitlements | Values for requested public entitlements. [**resolve_settings_without_workspace**](ActionsApi.md#resolve_settings_without_workspace) | **POST** /api/v1/actions/resolveSettings | Values for selected settings without workspace. [**retrieve_execution_metadata**](ActionsApi.md#retrieve_execution_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata | Get a single execution result's metadata. +[**retrieve_flow_result_binary**](ActionsApi.md#retrieve_flow_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary | (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format +[**retrieve_flow_result_metadata**](ActionsApi.md#retrieve_flow_result_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata | (EXPERIMENTAL) Get the metadata of a flow result +[**retrieve_flow_result_table**](ActionsApi.md#retrieve_flow_result_table) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table | (EXPERIMENTAL) Get a page of a flow result [**retrieve_result**](ActionsApi.md#retrieve_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId} | Get a single execution result [**retrieve_result_binary**](ActionsApi.md#retrieve_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary | (BETA) Get a single execution result in Apache Arrow File or Stream format [**retrieve_translations**](ActionsApi.md#retrieve_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/retrieve | Retrieve translations for entities. [**scan_data_source**](ActionsApi.md#scan_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scan | Scan a database to get a physical data model (PDM) [**scan_sql**](ActionsApi.md#scan_sql) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanSql | Collect metadata about SQL query -[**scan_statistics**](ActionsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a StarRocks data source +[**scan_statistics**](ActionsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a data source [**set_certification**](ActionsApi.md#set_certification) | **POST** /api/v1/actions/workspaces/{workspaceId}/setCertification | Set Certification [**set_translations**](ActionsApi.md#set_translations) | **POST** /api/v1/actions/workspaces/{workspaceId}/translations/set | Set translations for entities. [**staging_upload**](ActionsApi.md#staging_upload) | **POST** /api/v1/actions/fileStorage/staging/upload | Upload a file to the staging area [**switch_active_identity_provider**](ActionsApi.md#switch_active_identity_provider) | **POST** /api/v1/actions/organization/switchActiveIdentityProvider | Switch Active Identity Provider +[**sync_metadata**](ActionsApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization [**tags**](ActionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags [**test_data_source**](ActionsApi.md#test_data_source) | **POST** /api/v1/actions/dataSources/{dataSourceId}/test | Test data source connection by data source id [**test_data_source_definition**](ActionsApi.md#test_data_source_definition) | **POST** /api/v1/actions/dataSource/test | Test connection by data source definition @@ -140,6 +149,7 @@ Method | HTTP request | Description [**unsubscribe_workspace_automations**](ActionsApi.md#unsubscribe_workspace_automations) | **DELETE** /api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe | Unsubscribe from all automations in the workspace [**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_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. @@ -218,11 +228,11 @@ 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) # **ai_chat** -> ChatResult ai_chat(workspace_id, chat_request) +> ai_chat(workspace_id) -(BETA) Chat with AI +(REMOVED) Chat with AI -(BETA) Combines multiple use cases such as search, create visualizations, ... +Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. ### Example @@ -231,8 +241,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_request import ChatRequest 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. @@ -246,69 +254,11 @@ 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 - chat_request = ChatRequest( - allowed_relationship_types=[ - AllowedRelationshipType( - allow_orphans=True, - source_type="attribute", - target_type="attribute", - ), - ], - include_hidden=False, - limit_create=3, - limit_create_context=10, - limit_search=5, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - referenced_objects=[ - ObjectReferenceGroup( - context=ObjectReference( - id="id_example", - type="WIDGET", - ), - objects=[ - ObjectReference( - id="id_example", - type="WIDGET", - ), - ], - ), - ], - view=UIContext( - dashboard=DashboardContext( - id="id_example", - widgets=[ - WidgetDescriptor( - filters=[ - FilterDefinition(), - ], - title="title_example", - widget_id="widget_id_example", - widget_type="widget_type_example", - ), - ], - ), - ), - ), - ) # ChatRequest | # example passing only required values which don't have defaults set try: - # (BETA) Chat with AI - api_response = api_instance.ai_chat(workspace_id, chat_request) - pprint(api_response) + # (REMOVED) Chat with AI + api_instance.ai_chat(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->ai_chat: %s\n" % e) ``` @@ -319,11 +269,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type -[**ChatResult**](ChatResult.md) +void (empty response body) ### Authorization @@ -331,24 +280,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_history** -> ChatHistoryResult ai_chat_history(workspace_id, chat_history_request) +> ai_chat_history(workspace_id) -(BETA) Get Chat History +(REMOVED) Get Chat History -(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. +Removed. Chat history is served by the AI Assistant API. ### Example @@ -357,8 +306,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest 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. @@ -372,24 +319,11 @@ 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 - chat_history_request = ChatHistoryRequest( - chat_history_interaction_id="chat_history_interaction_id_example", - reset=True, - response_state="SUCCESSFUL", - saved_visualization=SavedVisualization( - created_visualization_id="created_visualization_id_example", - saved_visualization_id="saved_visualization_id_example", - ), - thread_id_suffix="thread_id_suffix_example", - user_feedback="POSITIVE", - user_text_feedback="user_text_feedback_example", - ) # ChatHistoryRequest | # example passing only required values which don't have defaults set try: - # (BETA) Get Chat History - api_response = api_instance.ai_chat_history(workspace_id, chat_history_request) - pprint(api_response) + # (REMOVED) Get Chat History + api_instance.ai_chat_history(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->ai_chat_history: %s\n" % e) ``` @@ -400,11 +334,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **chat_history_request** | [**ChatHistoryRequest**](ChatHistoryRequest.md)| | ### Return type -[**ChatHistoryResult**](ChatHistoryResult.md) +void (empty response body) ### Authorization @@ -412,24 +345,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_stream** -> [dict] ai_chat_stream(workspace_id, chat_request) +> ai_chat_stream(workspace_id) -(BETA) Chat with AI +(REMOVED) Chat with AI -(BETA) Combines multiple use cases such as search, create visualizations, ... +Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. ### Example @@ -438,7 +371,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_request import ChatRequest 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. @@ -452,69 +384,11 @@ 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 - chat_request = ChatRequest( - allowed_relationship_types=[ - AllowedRelationshipType( - allow_orphans=True, - source_type="attribute", - target_type="attribute", - ), - ], - include_hidden=False, - limit_create=3, - limit_create_context=10, - limit_search=5, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - referenced_objects=[ - ObjectReferenceGroup( - context=ObjectReference( - id="id_example", - type="WIDGET", - ), - objects=[ - ObjectReference( - id="id_example", - type="WIDGET", - ), - ], - ), - ], - view=UIContext( - dashboard=DashboardContext( - id="id_example", - widgets=[ - WidgetDescriptor( - filters=[ - FilterDefinition(), - ], - title="title_example", - widget_id="widget_id_example", - widget_type="widget_type_example", - ), - ], - ), - ), - ), - ) # ChatRequest | # example passing only required values which don't have defaults set try: - # (BETA) Chat with AI - api_response = api_instance.ai_chat_stream(workspace_id, chat_request) - pprint(api_response) + # (REMOVED) Chat with AI + api_instance.ai_chat_stream(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->ai_chat_stream: %s\n" % e) ``` @@ -525,11 +399,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type -**[dict]** +void (empty response body) ### Authorization @@ -537,24 +410,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: text/event-stream + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_usage** -> ChatUsageResponse ai_chat_usage(workspace_id) +> ai_chat_usage(workspace_id) -Get Chat Usage +(REMOVED) Get Chat Usage -Returns usage statistics of chat for a user in a workspace. +Removed. Chat usage is served by the AI Assistant API. ### Example @@ -563,7 +436,6 @@ Returns usage statistics of chat for a user in a workspace. import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse 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. @@ -580,9 +452,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get Chat Usage - api_response = api_instance.ai_chat_usage(workspace_id) - pprint(api_response) + # (REMOVED) Get Chat Usage + api_instance.ai_chat_usage(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->ai_chat_usage: %s\n" % e) ``` @@ -596,7 +467,7 @@ Name | Type | Description | Notes ### Return type -[**ChatUsageResponse**](ChatUsageResponse.md) +void (empty response body) ### Authorization @@ -605,108 +476,14 @@ 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) - -# **ai_search** -> SearchResult ai_search(workspace_id, search_request) - -(BETA) Semantic Search in Metadata - -(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.search_request import SearchRequest -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 - search_request = SearchRequest( - allowed_relationship_types=[ - AllowedRelationshipType( - allow_orphans=True, - source_type="attribute", - target_type="attribute", - ), - ], - deep_search=False, - enable_hybrid_search=False, - exclude_tags=[ - "exclude_tags_example", - ], - include_hidden=False, - include_tags=[ - "include_tags_example", - ], - limit=10, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.3, - title_to_descriptor_ratio=0.7, - ) # SearchRequest | - - # example passing only required values which don't have defaults set - try: - # (BETA) Semantic Search in Metadata - api_response = api_instance.ai_search(workspace_id, search_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->ai_search: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **search_request** | [**SearchRequest**](SearchRequest.md)| | - -### Return type - -[**SearchResult**](SearchResult.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1229,10 +1006,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) -# **cancel_workflow** -> {str: (str,)} cancel_workflow(workspace_id, run_id) +# **cancel_flows** +> AfmCancelTokens cancel_flows(workspace_id, afm_cancel_tokens) +(EXPERIMENTAL) Apply the given cancel tokens to flows +Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result. ### Example @@ -1241,6 +1020,7 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens 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. @@ -1254,14 +1034,19 @@ 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 - run_id = "runId_example" # str | + afm_cancel_tokens = AfmCancelTokens( + result_id_to_cancel_token_pairs={ + "key": "key_example", + }, + ) # AfmCancelTokens | # example passing only required values which don't have defaults set try: - api_response = api_instance.cancel_workflow(workspace_id, run_id) + # (EXPERIMENTAL) Apply the given cancel tokens to flows + api_response = api_instance.cancel_flows(workspace_id, afm_cancel_tokens) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->cancel_workflow: %s\n" % e) + print("Exception when calling ActionsApi->cancel_flows: %s\n" % e) ``` @@ -1270,11 +1055,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **run_id** | **str**| | + **afm_cancel_tokens** | [**AfmCancelTokens**](AfmCancelTokens.md)| | ### Return type -**{str: (str,)}** +[**AfmCancelTokens**](AfmCancelTokens.md) ### Authorization @@ -1282,7 +1067,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json @@ -1983,10 +1768,11 @@ with gooddata_api_client.ApiClient() as api_client: pattern_filter="pattern_filter_example", sort_order="ASC", timezone="Europe/Prague", + type="label", validate_by=[ ValidateByItem( id="id_example", - type="fact", + type="label", ), ], ) # ElementsRequest | @@ -2497,6 +2283,73 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **computed_attribute_permissions** +> ComputedAttributePermissions computed_attribute_permissions(workspace_id, computed_attribute_id) + +(BETA) Get Computed Attribute Permissions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.computed_attribute_permissions import ComputedAttributePermissions +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 | + computed_attribute_id = "computedAttributeId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Get Computed Attribute Permissions + api_response = api_instance.computed_attribute_permissions(workspace_id, computed_attribute_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->computed_attribute_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **computed_attribute_id** | **str**| | + +### Return type + +[**ComputedAttributePermissions**](ComputedAttributePermissions.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) + # **convert_geo_file** > ConvertGeoFileResponse convert_geo_file(convert_geo_file_request) @@ -2712,6 +2565,7 @@ with gooddata_api_client.ApiClient() as api_client: "widget_ids_example", ], ) # ImageExportRequest | + 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: @@ -2720,6 +2574,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ActionsApi->create_image_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create image export request + api_response = api_instance.create_image_export(workspace_id, image_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_image_export: %s\n" % e) ``` @@ -2729,6 +2592,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **image_export_request** | [**ImageExportRequest**](ImageExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type @@ -2976,12 +2840,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) -# **create_slides_export** -> ExportResponse create_slides_export(workspace_id, slides_export_request) +# **create_report_export** +> ExportResponse create_report_export(workspace_id, report_export_request) -(EXPERIMENTAL) Create slides export request +(EXPERIMENTAL) Create report export request -Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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. +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 @@ -2991,7 +2855,7 @@ 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.slides_export_request import SlidesExportRequest +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. @@ -3005,38 +2869,31 @@ 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 | - slides_export_request = SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + report_export_request = ReportExportRequest( file_name="filename", format="PDF", metadata=JsonNode(), - template_id="template_id_example", + report_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", timezone_id="Asia/Kolkata", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ) # SlidesExportRequest | + ) # 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 slides export request - api_response = api_instance.create_slides_export(workspace_id, slides_export_request) + # (EXPERIMENTAL) Create report export request + api_response = api_instance.create_report_export(workspace_id, report_export_request) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) + print("Exception when calling ActionsApi->create_report_export: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # (EXPERIMENTAL) Create slides export request - api_response = api_instance.create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) + # (EXPERIMENTAL) Create report export request + api_response = api_instance.create_report_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_slides_export: %s\n" % e) + print("Exception when calling ActionsApi->create_report_export: %s\n" % e) ``` @@ -3045,7 +2902,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.md)| | + **report_export_request** | [**ReportExportRequest**](ReportExportRequest.md)| | **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type @@ -3066,16 +2923,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Slides export request created successfully. | - | +**201** | Report 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_tabular_export** -> ExportResponse create_tabular_export(workspace_id, tabular_export_request) +# **create_slides_export** +> ExportResponse create_slides_export(workspace_id, slides_export_request) -Create tabular export request +(EXPERIMENTAL) Create slides export request -An tabular 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. +Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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 @@ -3085,7 +2942,7 @@ 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.tabular_export_request import TabularExportRequest +from gooddata_api_client.model.slides_export_request import SlidesExportRequest 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. @@ -3099,13 +2956,128 @@ 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 | - tabular_export_request = TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, + slides_export_request = SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + timezone_id="Asia/Kolkata", + visualization_ids=[ + "visualization_ids_example", + ], + widget_ids=[ + "widget_ids_example", + ], + ) # SlidesExportRequest | + 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 slides export request + api_response = api_instance.create_slides_export(workspace_id, slides_export_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create slides export request + api_response = api_instance.create_slides_export(workspace_id, slides_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->create_slides_export: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **slides_export_request** | [**SlidesExportRequest**](SlidesExportRequest.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** | Slides 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_tabular_export** +> ExportResponse create_tabular_export(workspace_id, tabular_export_request) + +Create tabular export request + +An tabular 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.tabular_export_request import TabularExportRequest +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 | + tabular_export_request = TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, metrics={ "key": CustomMetric( format="format_example", @@ -3629,6 +3601,90 @@ 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) +# **execute_flow** +> FlowExecutionResponse execute_flow(workspace_id, flow_request) + +(EXPERIMENTAL) Execute a flow + +Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.flow_execution_response import FlowExecutionResponse +from gooddata_api_client.model.flow_request import FlowRequest +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 + flow_request = FlowRequest( + inputs={ + "key": FlowInput(), + }, + transformations=[ + FlowTransformation( + id="id_example", + input_refs={ + "key": "key_example", + }, + operation="survey_weighting", + parameters={}, + ), + ], + ) # FlowRequest | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Execute a flow + api_response = api_instance.execute_flow(workspace_id, flow_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->execute_flow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **flow_request** | [**FlowRequest**](FlowRequest.md)| | + +### Return type + +[**FlowExecutionResponse**](FlowExecutionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The flow was accepted. | * X-GDC-CANCEL-TOKEN - A token that can be used to cancel this execution
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **explain_afm** > explain_afm(workspace_id, afm_execution) @@ -4012,80 +4068,6 @@ 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) - -# **generate_dashboard_summary** -> WorkflowDashboardSummaryResponseDto generate_dashboard_summary(workspace_id, workflow_dashboard_summary_request_dto) - - - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workflow_dashboard_summary_request_dto import WorkflowDashboardSummaryRequestDto -from gooddata_api_client.model.workflow_dashboard_summary_response_dto import WorkflowDashboardSummaryResponseDto -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 - workflow_dashboard_summary_request_dto = WorkflowDashboardSummaryRequestDto( - custom_user_prompt="custom_user_prompt_example", - dashboard_id="dashboard_id_example", - key_metric_ids=[ - "key_metric_ids_example", - ], - reference_quarter="reference_quarter_example", - ) # WorkflowDashboardSummaryRequestDto | - - # example passing only required values which don't have defaults set - try: - api_response = api_instance.generate_dashboard_summary(workspace_id, workflow_dashboard_summary_request_dto) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->generate_dashboard_summary: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **workflow_dashboard_summary_request_dto** | [**WorkflowDashboardSummaryRequestDto**](WorkflowDashboardSummaryRequestDto.md)| | - -### Return type - -[**WorkflowDashboardSummaryResponseDto**](WorkflowDashboardSummaryResponseDto.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - ### HTTP response details | Status code | Description | Response headers | @@ -5147,8 +5129,8 @@ 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_slides_export** -> file_type get_slides_export(workspace_id, export_id) +# **get_report_export** +> file_type get_report_export(workspace_id, export_id) (EXPERIMENTAL) Retrieve exported files @@ -5180,10 +5162,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_slides_export(workspace_id, export_id) + api_response = api_instance.get_report_export(workspace_id, export_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_slides_export: %s\n" % e) + print("Exception when calling ActionsApi->get_report_export: %s\n" % e) ``` @@ -5205,7 +5187,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/zip + - **Accept**: application/pdf ### HTTP response details @@ -5217,12 +5199,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_slides_export_metadata** -> get_slides_export_metadata(workspace_id, export_id) +# **get_report_export_metadata** +> get_report_export_metadata(workspace_id, export_id) (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/slides endpoint. The metadata structure is not verified. +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 @@ -5249,9 +5231,9 @@ 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_slides_export_metadata(workspace_id, export_id) + api_instance.get_report_export_metadata(workspace_id, export_id) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_slides_export_metadata: %s\n" % e) + print("Exception when calling ActionsApi->get_report_export_metadata: %s\n" % e) ``` @@ -5284,12 +5266,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_tabular_export** -> file_type get_tabular_export(workspace_id, export_id) +# **get_slides_export** +> file_type get_slides_export(workspace_id, export_id) -Retrieve exported files +(EXPERIMENTAL) Retrieve exported files -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. 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 @@ -5298,6 +5280,7 @@ After clients creates a POST export request, the processing of it will start sho 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. @@ -5315,11 +5298,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_tabular_export(workspace_id, export_id) + # (EXPERIMENTAL) Retrieve exported files + api_response = api_instance.get_slides_export(workspace_id, export_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_tabular_export: %s\n" % e) + print("Exception when calling ActionsApi->get_slides_export: %s\n" % e) ``` @@ -5341,7 +5324,7 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/zip, text/csv, text/html + - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/zip ### HTTP response details @@ -5353,12 +5336,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_translation_tags** -> [str] get_translation_tags(workspace_id) +# **get_slides_export_metadata** +> get_slides_export_metadata(workspace_id, export_id) -Get translation tags. +(EXPERIMENTAL) Retrieve metadata context -Provides a list of effective translation tags. +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/slides endpoint. The metadata structure is not verified. ### Example @@ -5380,14 +5363,14 @@ 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 | + export_id = "exportId_example" # str | # example passing only required values which don't have defaults set try: - # Get translation tags. - api_response = api_instance.get_translation_tags(workspace_id) - pprint(api_response) + # (EXPERIMENTAL) Retrieve metadata context + api_instance.get_slides_export_metadata(workspace_id, export_id) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_translation_tags: %s\n" % e) + print("Exception when calling ActionsApi->get_slides_export_metadata: %s\n" % e) ``` @@ -5396,10 +5379,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | + **export_id** | **str**| | ### Return type -**[str]** +void (empty response body) ### Authorization @@ -5415,14 +5399,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Retrieved list of translation tags. | - | +**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_workflow_status** -> WorkflowStatusResponseDto get_workflow_status(workspace_id, run_id) +# **get_tabular_export** +> file_type get_tabular_export(workspace_id, export_id) +Retrieve exported files +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 @@ -5431,7 +5417,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.workflow_status_response_dto import WorkflowStatusResponseDto 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. @@ -5444,15 +5429,16 @@ 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 - run_id = "runId_example" # str | + workspace_id = "workspaceId_example" # str | + export_id = "exportId_example" # str | # example passing only required values which don't have defaults set try: - api_response = api_instance.get_workflow_status(workspace_id, run_id) + # Retrieve exported files + api_response = api_instance.get_tabular_export(workspace_id, export_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->get_workflow_status: %s\n" % e) + print("Exception when calling ActionsApi->get_tabular_export: %s\n" % e) ``` @@ -5460,12 +5446,79 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **run_id** | **str**| | + **workspace_id** | **str**| | + **export_id** | **str**| | + +### Return type + +**file_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/pdf, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/zip, text/csv, text/html + + +### 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_translation_tags** +> [str] get_translation_tags(workspace_id) + +Get translation tags. + +Provides a list of effective translation tags. + +### 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 | + + # example passing only required values which don't have defaults set + try: + # Get translation tags. + api_response = api_instance.get_translation_tags(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->get_translation_tags: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | ### Return type -[**WorkflowStatusResponseDto**](WorkflowStatusResponseDto.md) +**[str]** ### Authorization @@ -5481,7 +5534,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**200** | Retrieved list of translation tags. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -6133,6 +6186,73 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **list_flow_operations** +> FlowOperations list_flow_operations(workspace_id) + +(EXPERIMENTAL) List the operations of flows + +Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.flow_operations import FlowOperations +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: + # (EXPERIMENTAL) List the operations of flows + api_response = api_instance.list_flow_operations(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->list_flow_operations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + +### Return type + +[**FlowOperations**](FlowOperations.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) + # **list_llm_provider_models** > ListLlmProviderModelsResponse list_llm_provider_models(list_llm_provider_models_request) @@ -6488,6 +6608,76 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **manage_computed_attribute_permissions** +> manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) + +(BETA) Manage Permissions for a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.manage_computed_attribute_permissions_request_inner import ManageComputedAttributePermissionsRequestInner +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 | + computed_attribute_id = "computedAttributeId_example" # str | + manage_computed_attribute_permissions_request_inner = [ + ManageComputedAttributePermissionsRequestInner(None), + ] # [ManageComputedAttributePermissionsRequestInner] | + + # example passing only required values which don't have defaults set + try: + # (BETA) Manage Permissions for a Computed Attribute + api_instance.manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->manage_computed_attribute_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **computed_attribute_id** | **str**| | + **manage_computed_attribute_permissions_request_inner** | [**[ManageComputedAttributePermissionsRequestInner]**](ManageComputedAttributePermissionsRequestInner.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -6922,6 +7112,76 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **manage_visualization_permissions** +> manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) + +(BETA) Manage Permissions for a Visualization + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.manage_visualization_permissions_request_inner import ManageVisualizationPermissionsRequestInner +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 | + visualization_object_id = "visualizationObjectId_example" # str | + manage_visualization_permissions_request_inner = [ + ManageVisualizationPermissionsRequestInner(None), + ] # [ManageVisualizationPermissionsRequestInner] | + + # example passing only required values which don't have defaults set + try: + # (BETA) Manage Permissions for a Visualization + api_instance.manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->manage_visualization_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **visualization_object_id** | **str**| | + **manage_visualization_permissions_request_inner** | [**[ManageVisualizationPermissionsRequestInner]**](ManageVisualizationPermissionsRequestInner.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -7743,6 +8003,78 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **process_invitation** +> process_invitation(invitation) + +Invite User + +Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.invitation import Invitation +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) + invitation = Invitation( + email="email_example", + first_name="first_name_example", + force_send=True, + last_name="last_name_example", + user_id="user_id_example", + ) # Invitation | + + # example passing only required values which don't have defaults set + try: + # Invite User + api_instance.process_invitation(invitation) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->process_invitation: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invitation** | [**Invitation**](Invitation.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -8223,12 +8555,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) -# **resolve_llm_endpoints** -> resolve_llm_endpoints(workspace_id) +# **resolve_llm_endpoints** +> resolve_llm_endpoints(workspace_id) + +Get Active LLM Endpoints for this workspace (Removed) + +Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders instead. Always returns 410 Gone. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + + # example passing only required values which don't have defaults set + try: + # Get Active LLM Endpoints for this workspace (Removed) + api_instance.resolve_llm_endpoints(workspace_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->resolve_llm_endpoints: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**410** | Gone | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **resolve_requested_entitlements** +> [ApiEntitlement] resolve_requested_entitlements(entitlements_request) + +Values for requested public entitlements. + +Resolves values for requested entitlements in the organization. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.api_entitlement import ApiEntitlement +from gooddata_api_client.model.entitlements_request import EntitlementsRequest +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) + entitlements_request = EntitlementsRequest( + entitlements_name=[ + "CacheStrategy", + ], + ) # EntitlementsRequest | + + # example passing only required values which don't have defaults set + try: + # Values for requested public entitlements. + api_response = api_instance.resolve_requested_entitlements(entitlements_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->resolve_requested_entitlements: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entitlements_request** | [**EntitlementsRequest**](EntitlementsRequest.md)| | + +### Return type + +[**[ApiEntitlement]**](ApiEntitlement.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **resolve_settings_without_workspace** +> [ResolvedSetting] resolve_settings_without_workspace(resolve_settings_request) -Get Active LLM Endpoints for this workspace (Removed) +Values for selected settings without workspace. -Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders instead. Always returns 410 Gone. +Resolves values for selected settings without workspace by current user, organization, or default settings. ### Example @@ -8237,6 +8706,8 @@ Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolve import time import gooddata_api_client from gooddata_api_client.api import actions_api +from gooddata_api_client.model.resolved_setting import ResolvedSetting +from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest 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. @@ -8249,14 +8720,27 @@ 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 + resolve_settings_request = ResolveSettingsRequest( + settings=["timezone"], + ) # ResolveSettingsRequest | + exclude_user_settings = False # bool | If true, user-level settings are excluded from resolution. (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: - # Get Active LLM Endpoints for this workspace (Removed) - api_instance.resolve_llm_endpoints(workspace_id) + # Values for selected settings without workspace. + api_response = api_instance.resolve_settings_without_workspace(resolve_settings_request) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->resolve_llm_endpoints: %s\n" % e) + print("Exception when calling ActionsApi->resolve_settings_without_workspace: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Values for selected settings without workspace. + api_response = api_instance.resolve_settings_without_workspace(resolve_settings_request, exclude_user_settings=exclude_user_settings) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->resolve_settings_without_workspace: %s\n" % e) ``` @@ -8264,11 +8748,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | + **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | + **exclude_user_settings** | **bool**| If true, user-level settings are excluded from resolution. | [optional] if omitted the server will use the default value of False ### Return type -void (empty response body) +[**[ResolvedSetting]**](ResolvedSetting.md) ### Authorization @@ -8276,24 +8761,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **Content-Type**: application/json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**410** | Gone | - | +**200** | Values for selected settings. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **resolve_llm_providers** -> ResolvedLlms resolve_llm_providers(workspace_id) +# **retrieve_execution_metadata** +> ResultCacheMetadata retrieve_execution_metadata(workspace_id, result_id) -Get Active LLM configuration for this workspace +Get a single execution result's metadata. -Resolves the active LLM provider configuration for the given workspace. +The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse ### Example @@ -8302,7 +8787,7 @@ Resolves the active LLM provider configuration for the given workspace. import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_llms import ResolvedLlms +from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata 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. @@ -8316,14 +8801,15 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = actions_api.ActionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID # example passing only required values which don't have defaults set try: - # Get Active LLM configuration for this workspace - api_response = api_instance.resolve_llm_providers(workspace_id) + # Get a single execution result's metadata. + api_response = api_instance.retrieve_execution_metadata(workspace_id, result_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->resolve_llm_providers: %s\n" % e) + print("Exception when calling ActionsApi->retrieve_execution_metadata: %s\n" % e) ``` @@ -8332,10 +8818,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | ### Return type -[**ResolvedLlms**](ResolvedLlms.md) +[**ResultCacheMetadata**](ResultCacheMetadata.md) ### Authorization @@ -8351,16 +8838,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**200** | Execution result's metadata was found and returned. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **resolve_requested_entitlements** -> [ApiEntitlement] resolve_requested_entitlements(entitlements_request) +# **retrieve_flow_result_binary** +> file_type retrieve_flow_result_binary(workspace_id, result_id) -Values for requested public entitlements. +(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format -Resolves values for requested entitlements in the organization. +Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream. ### Example @@ -8369,8 +8856,6 @@ Resolves values for requested entitlements in the organization. import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.api_entitlement import ApiEntitlement -from gooddata_api_client.model.entitlements_request import EntitlementsRequest 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. @@ -8383,19 +8868,29 @@ 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) - entitlements_request = EntitlementsRequest( - entitlements_name=[ - "CacheStrategy", - ], - ) # EntitlementsRequest | + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + row_offset = 1 # int | Index of the first row to return. The default is 0. (optional) + row_limit = 1 # int | Maximum number of rows to return. The default is all remaining rows. (optional) + column_offset = 1 # int | Index of the first column to return. The default is 0. (optional) + column_limit = 1 # int | Maximum number of columns to return. The default is all remaining columns. (optional) # example passing only required values which don't have defaults set try: - # Values for requested public entitlements. - api_response = api_instance.resolve_requested_entitlements(entitlements_request) + # (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format + api_response = api_instance.retrieve_flow_result_binary(workspace_id, result_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->resolve_requested_entitlements: %s\n" % e) + print("Exception when calling ActionsApi->retrieve_flow_result_binary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format + api_response = api_instance.retrieve_flow_result_binary(workspace_id, result_id, row_offset=row_offset, row_limit=row_limit, column_offset=column_offset, column_limit=column_limit) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->retrieve_flow_result_binary: %s\n" % e) ``` @@ -8403,11 +8898,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **entitlements_request** | [**EntitlementsRequest**](EntitlementsRequest.md)| | + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **row_offset** | **int**| Index of the first row to return. The default is 0. | [optional] + **row_limit** | **int**| Maximum number of rows to return. The default is all remaining rows. | [optional] + **column_offset** | **int**| Index of the first column to return. The default is 0. | [optional] + **column_limit** | **int**| Maximum number of columns to return. The default is all remaining columns. | [optional] ### Return type -[**[ApiEntitlement]**](ApiEntitlement.md) +**file_type** ### Authorization @@ -8415,24 +8915,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**200** | The result. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **resolve_settings_without_workspace** -> [ResolvedSetting] resolve_settings_without_workspace(resolve_settings_request) +# **retrieve_flow_result_metadata** +> FlowResultMetadata retrieve_flow_result_metadata(workspace_id, result_id) -Values for selected settings without workspace. +(EXPERIMENTAL) Get the metadata of a flow result -Resolves values for selected settings without workspace by current user, organization, or default settings. +Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result. ### Example @@ -8441,8 +8941,7 @@ Resolves values for selected settings without workspace by current user, organiz import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.resolved_setting import ResolvedSetting -from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest +from gooddata_api_client.model.flow_result_metadata import FlowResultMetadata 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. @@ -8455,27 +8954,16 @@ 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) - resolve_settings_request = ResolveSettingsRequest( - settings=["timezone"], - ) # ResolveSettingsRequest | - exclude_user_settings = False # bool | If true, user-level settings are excluded from resolution. (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # Values for selected settings without workspace. - api_response = api_instance.resolve_settings_without_workspace(resolve_settings_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->resolve_settings_without_workspace: %s\n" % e) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID # example passing only required values which don't have defaults set - # and optional values try: - # Values for selected settings without workspace. - api_response = api_instance.resolve_settings_without_workspace(resolve_settings_request, exclude_user_settings=exclude_user_settings) + # (EXPERIMENTAL) Get the metadata of a flow result + api_response = api_instance.retrieve_flow_result_metadata(workspace_id, result_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->resolve_settings_without_workspace: %s\n" % e) + print("Exception when calling ActionsApi->retrieve_flow_result_metadata: %s\n" % e) ``` @@ -8483,12 +8971,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **resolve_settings_request** | [**ResolveSettingsRequest**](ResolveSettingsRequest.md)| | - **exclude_user_settings** | **bool**| If true, user-level settings are excluded from resolution. | [optional] if omitted the server will use the default value of False + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | ### Return type -[**[ResolvedSetting]**](ResolvedSetting.md) +[**FlowResultMetadata**](FlowResultMetadata.md) ### Authorization @@ -8496,7 +8984,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json + - **Content-Type**: Not defined - **Accept**: application/json @@ -8504,16 +8992,16 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Values for selected settings. | - | +**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) -# **retrieve_execution_metadata** -> ResultCacheMetadata retrieve_execution_metadata(workspace_id, result_id) +# **retrieve_flow_result_table** +> FlowTableResult retrieve_flow_result_table(workspace_id, result_id) -Get a single execution result's metadata. +(EXPERIMENTAL) Get a page of a flow result -The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse +Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result. ### Example @@ -8522,7 +9010,7 @@ The resource provides execution result's metadata as AFM and resultSpec used in import time import gooddata_api_client from gooddata_api_client.api import actions_api -from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata +from gooddata_api_client.model.flow_table_result import FlowTableResult 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. @@ -8537,14 +9025,27 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = actions_api.ActionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + row_offset = 1 # int | Index of the first row to return. The default is 0. (optional) + row_limit = 1 # int | Maximum number of rows to return. The default is all remaining rows. (optional) + column_offset = 1 # int | Index of the first column to return. The default is 0. (optional) + column_limit = 1 # int | Maximum number of columns to return. The default is all remaining columns. (optional) # example passing only required values which don't have defaults set try: - # Get a single execution result's metadata. - api_response = api_instance.retrieve_execution_metadata(workspace_id, result_id) + # (EXPERIMENTAL) Get a page of a flow result + api_response = api_instance.retrieve_flow_result_table(workspace_id, result_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling ActionsApi->retrieve_execution_metadata: %s\n" % e) + print("Exception when calling ActionsApi->retrieve_flow_result_table: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Get a page of a flow result + api_response = api_instance.retrieve_flow_result_table(workspace_id, result_id, row_offset=row_offset, row_limit=row_limit, column_offset=column_offset, column_limit=column_limit) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->retrieve_flow_result_table: %s\n" % e) ``` @@ -8554,10 +9055,14 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | **result_id** | **str**| Result ID | + **row_offset** | **int**| Index of the first row to return. The default is 0. | [optional] + **row_limit** | **int**| Maximum number of rows to return. The default is all remaining rows. | [optional] + **column_offset** | **int**| Index of the first column to return. The default is 0. | [optional] + **column_limit** | **int**| Maximum number of columns to return. The default is all remaining columns. | [optional] ### Return type -[**ResultCacheMetadata**](ResultCacheMetadata.md) +[**FlowTableResult**](FlowTableResult.md) ### Authorization @@ -8573,7 +9078,7 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Execution result's metadata was found and returned. | - | +**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) @@ -8972,9 +9477,9 @@ No authorization required # **scan_statistics** > TableStatisticsResponse scan_statistics(data_source_id, table_statistics_request) -(BETA) Collect physical table and column statistics from a StarRocks data source +(BETA) Collect physical table and column statistics from a data source -(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values. +(BETA) Reads the statistics the database already maintains in its own catalog, without scanning any data. Supported for StarRocks (both internal catalog for native/PIPE tables and external catalog for Iceberg tables), BigQuery, PostgreSQL, Redshift, Snowflake, Vertica, SQL Server, Azure SQL, MySQL, MariaDB and SingleStore. Statistics include row counts and data sizes, and, where the database exposes them, NDV (number of distinct values), null counts and min/max values. Returns an empty result for a data source whose database exposes no such catalog. Also returns an empty result for a data source that sets disableStatistics. ### Example @@ -9009,7 +9514,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Collect physical table and column statistics from a StarRocks data source + # (BETA) Collect physical table and column statistics from a data source api_response = api_instance.scan_statistics(data_source_id, table_statistics_request) pprint(api_response) except gooddata_api_client.ApiException as e: @@ -9362,6 +9867,67 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **sync_metadata** +> sync_metadata() + +Trigger metadata synchronization + +Enqueues an organization-scoped metadata resync, fanning out the organization's current metadata to GenAI, GW Forge, and Automations. Requires organization MANAGE permission. Requests are deduplicated while a resync session is pending for the organization. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = actions_api.ActionsApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Trigger metadata synchronization + api_instance.sync_metadata() + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->sync_metadata: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -10066,6 +10632,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -10240,6 +10811,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -11101,6 +11693,73 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **visualization_permissions** +> VisualizationPermissions visualization_permissions(workspace_id, visualization_object_id) + +(BETA) Get Visualization Permissions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import actions_api +from gooddata_api_client.model.visualization_permissions import VisualizationPermissions +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 | + visualization_object_id = "visualizationObjectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Get Visualization Permissions + api_response = api_instance.visualization_permissions(workspace_id, visualization_object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ActionsApi->visualization_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **visualization_object_id** | **str**| | + +### Return type + +[**VisualizationPermissions**](VisualizationPermissions.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_resolve_all_settings** > [ResolvedSetting] workspace_resolve_all_settings(workspace_id) diff --git a/gooddata-api-client/docs/VisualizationConfig.md b/gooddata-api-client/docs/AfmFlowInput.md similarity index 52% rename from gooddata-api-client/docs/VisualizationConfig.md rename to gooddata-api-client/docs/AfmFlowInput.md index 18e35d64b..dff5e0adf 100644 --- a/gooddata-api-client/docs/VisualizationConfig.md +++ b/gooddata-api-client/docs/AfmFlowInput.md @@ -1,14 +1,13 @@ -# VisualizationConfig +# AfmFlowInput -Visualization config for smart-function rendering. +Computes an AFM as /afm/execute does, and reads its rows as a table. It has a column for each attribute and each measure of the AFM, named by its local identifier, the attributes first. Each attribute must use a label of its own. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**anomaly_detection** | [**AnomalyDetectionConfig**](AnomalyDetectionConfig.md) | | [optional] -**clustering** | [**ClusteringConfig**](ClusteringConfig.md) | | [optional] -**forecast** | [**ForecastConfig**](ForecastConfig.md) | | [optional] -**what_if** | [**WhatIfScenarioConfig**](WhatIfScenarioConfig.md) | | [optional] +**execution** | [**AFM**](AFM.md) | | +**type** | **str** | Type of the input. | defaults to "afm" +**settings** | [**ExecutionSettings**](ExecutionSettings.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/AfmFlowInputAllOf.md b/gooddata-api-client/docs/AfmFlowInputAllOf.md new file mode 100644 index 000000000..8cad70d82 --- /dev/null +++ b/gooddata-api-client/docs/AfmFlowInputAllOf.md @@ -0,0 +1,14 @@ +# AfmFlowInputAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**execution** | [**AFM**](AFM.md) | | [optional] +**settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**type** | **str** | Type of the input. | [optional] if omitted the server will use the default value of "afm" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md b/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md index f47d11e58..1614656fd 100644 --- a/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md +++ b/gooddata-api-client/docs/AfmObjectIdentifierLabelIdentifier.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**type** | **str** | | defaults to "label" +**type** | **str** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/AgentControllerApi.md b/gooddata-api-client/docs/AgentControllerApi.md index 3f53fd77f..4424ce4ef 100644 --- a/gooddata-api-client/docs/AgentControllerApi.md +++ b/gooddata-api-client/docs/AgentControllerApi.md @@ -50,6 +50,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -383,6 +391,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -494,6 +510,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", diff --git a/gooddata-api-client/docs/AIAgentsApi.md b/gooddata-api-client/docs/AgentsApi.md similarity index 89% rename from gooddata-api-client/docs/AIAgentsApi.md rename to gooddata-api-client/docs/AgentsApi.md index e57446509..2fe10267d 100644 --- a/gooddata-api-client/docs/AIAgentsApi.md +++ b/gooddata-api-client/docs/AgentsApi.md @@ -1,15 +1,15 @@ -# gooddata_api_client.AIAgentsApi +# gooddata_api_client.AgentsApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_entity_agents**](AIAgentsApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities -[**delete_entity_agents**](AIAgentsApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity -[**get_all_entities_agents**](AIAgentsApi.md#get_all_entities_agents) | **GET** /api/v1/entities/agents | Get all Agent entities -[**get_entity_agents**](AIAgentsApi.md#get_entity_agents) | **GET** /api/v1/entities/agents/{id} | Get Agent entity -[**patch_entity_agents**](AIAgentsApi.md#patch_entity_agents) | **PATCH** /api/v1/entities/agents/{id} | Patch Agent entity -[**update_entity_agents**](AIAgentsApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity +[**create_entity_agents**](AgentsApi.md#create_entity_agents) | **POST** /api/v1/entities/agents | Post Agent entities +[**delete_entity_agents**](AgentsApi.md#delete_entity_agents) | **DELETE** /api/v1/entities/agents/{id} | Delete Agent entity +[**get_all_entities_agents**](AgentsApi.md#get_all_entities_agents) | **GET** /api/v1/entities/agents | Get all Agent entities +[**get_entity_agents**](AgentsApi.md#get_entity_agents) | **GET** /api/v1/entities/agents/{id} | Get Agent entity +[**patch_entity_agents**](AgentsApi.md#patch_entity_agents) | **PATCH** /api/v1/entities/agents/{id} | Patch Agent entity +[**update_entity_agents**](AgentsApi.md#update_entity_agents) | **PUT** /api/v1/entities/agents/{id} | Put Agent entity # **create_entity_agents** @@ -25,7 +25,7 @@ AI Agent - behavior configuration for AI assistants ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_agents_api +from gooddata_api_client.api import agents_api from gooddata_api_client.model.json_api_agent_in_document import JsonApiAgentInDocument from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument from pprint import pprint @@ -39,7 +39,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_agents_api.AIAgentsApi(api_client) + api_instance = agents_api.AgentsApi(api_client) json_api_agent_in_document = JsonApiAgentInDocument( data=JsonApiAgentIn( attributes=JsonApiAgentInAttributes( @@ -50,6 +50,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -79,7 +87,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.create_entity_agents(json_api_agent_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->create_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->create_entity_agents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -88,7 +96,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.create_entity_agents(json_api_agent_in_document, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->create_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->create_entity_agents: %s\n" % e) ``` @@ -132,7 +140,7 @@ Delete Agent entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_agents_api +from gooddata_api_client.api import agents_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. @@ -144,7 +152,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_agents_api.AIAgentsApi(api_client) + api_instance = agents_api.AgentsApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set @@ -152,7 +160,7 @@ with gooddata_api_client.ApiClient() as api_client: # Delete Agent entity api_instance.delete_entity_agents(id) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->delete_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->delete_entity_agents: %s\n" % e) ``` @@ -195,7 +203,7 @@ Get all Agent entities ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_agents_api +from gooddata_api_client.api import agents_api from gooddata_api_client.model.json_api_agent_out_list import JsonApiAgentOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -208,7 +216,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_agents_api.AIAgentsApi(api_client) + api_instance = agents_api.AgentsApi(api_client) filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ "createdBy,modifiedBy,userGroups", @@ -229,7 +237,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.get_all_entities_agents(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->get_all_entities_agents: %s\n" % e) + print("Exception when calling AgentsApi->get_all_entities_agents: %s\n" % e) ``` @@ -277,7 +285,7 @@ Get Agent entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_agents_api +from gooddata_api_client.api import agents_api from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost @@ -290,7 +298,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_agents_api.AIAgentsApi(api_client) + api_instance = agents_api.AgentsApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ @@ -303,7 +311,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.get_entity_agents(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->get_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->get_entity_agents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -312,7 +320,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.get_entity_agents(id, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->get_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->get_entity_agents: %s\n" % e) ``` @@ -357,7 +365,7 @@ Patch Agent entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_agents_api +from gooddata_api_client.api import agents_api from gooddata_api_client.model.json_api_agent_patch_document import JsonApiAgentPatchDocument from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument from pprint import pprint @@ -371,7 +379,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_agents_api.AIAgentsApi(api_client) + api_instance = agents_api.AgentsApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | json_api_agent_patch_document = JsonApiAgentPatchDocument( data=JsonApiAgentPatch( @@ -383,6 +391,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -413,7 +429,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.patch_entity_agents(id, json_api_agent_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->patch_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->patch_entity_agents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -422,7 +438,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.patch_entity_agents(id, json_api_agent_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->patch_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->patch_entity_agents: %s\n" % e) ``` @@ -468,7 +484,7 @@ Put Agent entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_agents_api +from gooddata_api_client.api import agents_api from gooddata_api_client.model.json_api_agent_in_document import JsonApiAgentInDocument from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument from pprint import pprint @@ -482,7 +498,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_agents_api.AIAgentsApi(api_client) + api_instance = agents_api.AgentsApi(api_client) id = "/6bUUGjjNSwg0_bs" # str | json_api_agent_in_document = JsonApiAgentInDocument( data=JsonApiAgentIn( @@ -494,6 +510,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -524,7 +548,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.update_entity_agents(id, json_api_agent_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->update_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->update_entity_agents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values @@ -533,7 +557,7 @@ with gooddata_api_client.ApiClient() as api_client: api_response = api_instance.update_entity_agents(id, json_api_agent_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIAgentsApi->update_entity_agents: %s\n" % e) + print("Exception when calling AgentsApi->update_entity_agents: %s\n" % e) ``` diff --git a/gooddata-api-client/docs/AllowedRelationshipType.md b/gooddata-api-client/docs/AllowedRelationshipType.md deleted file mode 100644 index 4b7e4af81..000000000 --- a/gooddata-api-client/docs/AllowedRelationshipType.md +++ /dev/null @@ -1,15 +0,0 @@ -# AllowedRelationshipType - -Allowed relationship type combination. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source_type** | **str** | Source object type (e.g., 'dashboard', 'visualization', 'metric'). | -**target_type** | **str** | Target object type (e.g., 'visualization', 'metric', 'attribute'). | -**allow_orphans** | **bool** | If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed). | [optional] if omitted the server will use the default value of True -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md b/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md index 9c4e25836..96eb6d3d1 100644 --- a/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md +++ b/gooddata-api-client/docs/AnalyticalDashboardControllerApi.md @@ -57,7 +57,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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,origin,accessInfo,all", @@ -207,7 +207,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -303,7 +303,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -408,7 +408,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAnalyticalDashboardPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -607,7 +607,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAnalyticalDashboardInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/AnalyticsModelApi.md b/gooddata-api-client/docs/AnalyticsModelApi.md index e178c8c17..2a7022bb9 100644 --- a/gooddata-api-client/docs/AnalyticsModelApi.md +++ b/gooddata-api-client/docs/AnalyticsModelApi.md @@ -175,6 +175,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -255,6 +291,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -293,6 +344,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -302,6 +391,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( diff --git a/gooddata-api-client/docs/AttributeControllerApi.md b/gooddata-api-client/docs/AttributeControllerApi.md index d07288168..2842bb706 100644 --- a/gooddata-api-client/docs/AttributeControllerApi.md +++ b/gooddata-api-client/docs/AttributeControllerApi.md @@ -48,7 +48,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -139,7 +139,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -225,6 +225,21 @@ with gooddata_api_client.ApiClient() as api_client: json_api_attribute_patch_document = JsonApiAttributePatchDocument( data=JsonApiAttributePatch( attributes=JsonApiAttributePatchAttributes( + conditional_formatting=JsonApiAttributeOutAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/AttributesApi.md b/gooddata-api-client/docs/AttributesApi.md index 2e606687c..1b86c6eac 100644 --- a/gooddata-api-client/docs/AttributesApi.md +++ b/gooddata-api-client/docs/AttributesApi.md @@ -48,7 +48,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -139,7 +139,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -225,6 +225,21 @@ with gooddata_api_client.ApiClient() as api_client: json_api_attribute_patch_document = JsonApiAttributePatchDocument( data=JsonApiAttributePatch( attributes=JsonApiAttributePatchAttributes( + conditional_formatting=JsonApiAttributeOutAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/AutomationAlert.md b/gooddata-api-client/docs/AutomationAlert.md index 7f0952654..544afad35 100644 --- a/gooddata-api-client/docs/AutomationAlert.md +++ b/gooddata-api-client/docs/AutomationAlert.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **condition** | [**AlertCondition**](AlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | **interval** | **str** | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] +**settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] **trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. | [optional] if omitted the server will use the default value of "ALWAYS" **any string name** | **bool, 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/AutomationControllerApi.md b/gooddata-api-client/docs/AutomationControllerApi.md index 718699ff4..3a845e532 100644 --- a/gooddata-api-client/docs/AutomationControllerApi.md +++ b/gooddata-api-client/docs/AutomationControllerApi.md @@ -78,6 +78,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -244,6 +249,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -363,7 +389,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAutomationInDocument | include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -513,7 +539,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -609,7 +635,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -734,6 +760,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -900,6 +931,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -1020,7 +1072,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationPatchDocument | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -1239,6 +1291,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -1405,6 +1462,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -1525,7 +1603,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationInDocument | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/AutomationsApi.md b/gooddata-api-client/docs/AutomationsApi.md index c1e07a935..875c4b94b 100644 --- a/gooddata-api-client/docs/AutomationsApi.md +++ b/gooddata-api-client/docs/AutomationsApi.md @@ -95,6 +95,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -261,6 +266,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -380,7 +406,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAutomationInDocument | include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -755,7 +781,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -931,7 +957,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -1056,6 +1082,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -1222,6 +1253,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -1342,7 +1394,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationPatchDocument | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -1802,6 +1854,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -2000,6 +2057,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -2195,6 +2273,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -2369,6 +2452,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -3103,6 +3207,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -3269,6 +3378,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -3389,7 +3519,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationInDocument | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/CertificationInfo.md b/gooddata-api-client/docs/CertificationInfo.md deleted file mode 100644 index d3fa8dbb2..000000000 --- a/gooddata-api-client/docs/CertificationInfo.md +++ /dev/null @@ -1,14 +0,0 @@ -# CertificationInfo - -Certification state of the object. Who certified and when are never exposed here. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **str** | Certification status, e.g. CERTIFIED. | -**certification_message** | **str** | Optional message describing the certification. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ChangeAnalysisParams.md b/gooddata-api-client/docs/ChangeAnalysisParams.md deleted file mode 100644 index 541b74d5c..000000000 --- a/gooddata-api-client/docs/ChangeAnalysisParams.md +++ /dev/null @@ -1,20 +0,0 @@ -# ChangeAnalysisParams - -Change analysis specification. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**analyzed_period** | **str** | The analyzed time period | -**attributes** | [**[AttributeItem]**](AttributeItem.md) | Attributes to analyze for significant changes | -**date_attribute** | [**AttributeItem**](AttributeItem.md) | | -**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Optional filters to apply | -**measure** | [**MeasureItem**](MeasureItem.md) | | -**measure_title** | **str** | The title of the measure being analyzed | -**reference_period** | **str** | The reference time period | -**use_smart_attribute_selection** | **bool** | Whether to use smart attribute selection | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ChatHistoryInteraction.md b/gooddata-api-client/docs/ChatHistoryInteraction.md deleted file mode 100644 index 4d7640ed2..000000000 --- a/gooddata-api-client/docs/ChatHistoryInteraction.md +++ /dev/null @@ -1,25 +0,0 @@ -# ChatHistoryInteraction - -List of chat history interactions. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chat_history_interaction_id** | **str** | Chat History interaction ID. Unique ID for each interaction. | -**interaction_finished** | **bool** | Has the interaction already finished? Can be used for polling when interaction is in progress. | -**question** | **str** | User question | -**routing** | [**RouteResult**](RouteResult.md) | | -**change_analysis_params** | [**ChangeAnalysisParams**](ChangeAnalysisParams.md) | | [optional] -**created_visualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] -**error_response** | **str** | Error response in anything fails. | [optional] -**found_objects** | [**FoundObjects**](FoundObjects.md) | | [optional] -**reasoning** | [**Reasoning**](Reasoning.md) | | [optional] -**semantic_search** | [**SearchResult**](SearchResult.md) | | [optional] -**text_response** | **str** | Text response for general questions. | [optional] -**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] -**user_feedback** | **str** | User feedback. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ChatHistoryRequest.md b/gooddata-api-client/docs/ChatHistoryRequest.md deleted file mode 100644 index c44ca741c..000000000 --- a/gooddata-api-client/docs/ChatHistoryRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# ChatHistoryRequest - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**chat_history_interaction_id** | **str** | Return chat history records only after this interaction ID. If empty, complete chat history is returned. | [optional] -**reset** | **bool** | User feedback. | [optional] -**response_state** | **str** | Response state indicating the outcome of the AI interaction. | [optional] -**saved_visualization** | [**SavedVisualization**](SavedVisualization.md) | | [optional] -**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] -**user_feedback** | **str** | User feedback. | [optional] -**user_text_feedback** | **str** | User text feedback for the interaction. | [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/ChatHistoryResult.md b/gooddata-api-client/docs/ChatHistoryResult.md deleted file mode 100644 index 2d9afc5fc..000000000 --- a/gooddata-api-client/docs/ChatHistoryResult.md +++ /dev/null @@ -1,13 +0,0 @@ -# ChatHistoryResult - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**interactions** | [**[ChatHistoryInteraction]**](ChatHistoryInteraction.md) | List of chat history interactions. | -**thread_id** | **str** | The conversation thread ID. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ChatRequest.md b/gooddata-api-client/docs/ChatRequest.md deleted file mode 100644 index 0894a23ef..000000000 --- a/gooddata-api-client/docs/ChatRequest.md +++ /dev/null @@ -1,23 +0,0 @@ -# ChatRequest - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**question** | **str** | User question | -**allowed_relationship_types** | [**[AllowedRelationshipType]**](AllowedRelationshipType.md) | Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users). | [optional] -**include_hidden** | **bool** | If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true. | [optional] if omitted the server will use the default value of False -**limit_create** | **int** | Maximum number of created results. | [optional] if omitted the server will use the default value of 3 -**limit_create_context** | **int** | Maximum number of relevant objects included into context for LLM (for each object type). | [optional] if omitted the server will use the default value of 10 -**limit_search** | **int** | Maximum number of search results. | [optional] if omitted the server will use the default value of 5 -**object_types** | **[str]** | List of object types to filter the search and visualization building. If empty or null, all object types are considered. | [optional] -**relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] if omitted the server will use the default value of 0.45 -**search_score_threshold** | **float** | Score, above which we return found object(s) and don't call LLM to create new objects. | [optional] if omitted the server will use the default value of 0.9 -**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] -**title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7 -**user_context** | [**UserContext**](UserContext.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ChatResult.md b/gooddata-api-client/docs/ChatResult.md deleted file mode 100644 index 96744e0bb..000000000 --- a/gooddata-api-client/docs/ChatResult.md +++ /dev/null @@ -1,22 +0,0 @@ -# ChatResult - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**change_analysis_params** | [**ChangeAnalysisParams**](ChangeAnalysisParams.md) | | [optional] -**chat_history_interaction_id** | **str** | Chat History interaction ID. Unique ID for each interaction. | [optional] -**created_visualizations** | [**CreatedVisualizations**](CreatedVisualizations.md) | | [optional] -**error_response** | **str** | Error response in anything fails. | [optional] -**found_objects** | [**FoundObjects**](FoundObjects.md) | | [optional] -**reasoning** | [**Reasoning**](Reasoning.md) | | [optional] -**routing** | [**RouteResult**](RouteResult.md) | | [optional] -**semantic_search** | [**SearchResult**](SearchResult.md) | | [optional] -**text_response** | **str** | Text response for general questions. | [optional] -**thread_id_suffix** | **str** | Chat History thread suffix appended to ID generated by backend. Enables more chat windows. | [optional] -**usage** | [**[AiUsageMetadataItem]**](AiUsageMetadataItem.md) | AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit). | [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/ChatUsageResponse.md b/gooddata-api-client/docs/ChatUsageResponse.md deleted file mode 100644 index 79f7c4130..000000000 --- a/gooddata-api-client/docs/ChatUsageResponse.md +++ /dev/null @@ -1,14 +0,0 @@ -# ChatUsageResponse - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**interaction_count** | **int** | Number of interactions in the time window | -**interaction_limit** | **int** | Maximum number of interactions in the time window any user can do in the workspace | -**time_window_hours** | **int** | Time window in hours | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ClusteringConfig.md b/gooddata-api-client/docs/ClusteringConfig.md deleted file mode 100644 index 245f4a347..000000000 --- a/gooddata-api-client/docs/ClusteringConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# ClusteringConfig - -Clustering configuration. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number_of_clusters** | **int** | Number of clusters to create | -**threshold** | **float** | Clustering algorithm threshold | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ClusteringResult.md b/gooddata-api-client/docs/ClusteringResult.md index 4bf71a5de..4b6a98b24 100644 --- a/gooddata-api-client/docs/ClusteringResult.md +++ b/gooddata-api-client/docs/ClusteringResult.md @@ -6,10 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute** | **[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]** | | **clusters** | **[int, none_type]** | | -**xcoord** | **[float]** | | -**ycoord** | **[float]** | | -**x_coord** | **[float, none_type]** | | [optional] -**y_coord** | **[float, none_type]** | | [optional] +**xcoord** | **[float, none_type]** | | +**ycoord** | **[float, none_type]** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ColumnExpression.md b/gooddata-api-client/docs/ColumnExpression.md deleted file mode 100644 index 8f7db02fa..000000000 --- a/gooddata-api-client/docs/ColumnExpression.md +++ /dev/null @@ -1,14 +0,0 @@ -# ColumnExpression - -Single column projection override: applies `function(column)` to a source column. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**column** | **str** | Source column produced by parquet schema inference (after columnOverrides). | -**function** | **str** | StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ColumnInfo.md b/gooddata-api-client/docs/ColumnInfo.md deleted file mode 100644 index 00635ae8e..000000000 --- a/gooddata-api-client/docs/ColumnInfo.md +++ /dev/null @@ -1,14 +0,0 @@ -# ColumnInfo - -A single column definition inferred from the parquet schema - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Column name | -**type** | **str** | SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE) | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ColumnPartitionConfig.md b/gooddata-api-client/docs/ColumnPartitionConfig.md deleted file mode 100644 index d71a7fab2..000000000 --- a/gooddata-api-client/docs/ColumnPartitionConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# ColumnPartitionConfig - -Partition by column expression. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | **[str]** | Columns to partition by. | -**type** | **str** | | defaults to "column" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ComputationApi.md b/gooddata-api-client/docs/ComputationApi.md index 723db5d67..a951dac04 100644 --- a/gooddata-api-client/docs/ComputationApi.md +++ b/gooddata-api-client/docs/ComputationApi.md @@ -409,10 +409,11 @@ with gooddata_api_client.ApiClient() as api_client: pattern_filter="pattern_filter_example", sort_order="ASC", timezone="Europe/Prague", + type="label", validate_by=[ ValidateByItem( id="id_example", - type="fact", + type="label", ), ], ) # ElementsRequest | diff --git a/gooddata-api-client/docs/ComputedAttributeControllerApi.md b/gooddata-api-client/docs/ComputedAttributeControllerApi.md new file mode 100644 index 000000000..9a03b70cb --- /dev/null +++ b/gooddata-api-client/docs/ComputedAttributeControllerApi.md @@ -0,0 +1,690 @@ +# gooddata_api_client.ComputedAttributeControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_computed_attributes**](ComputedAttributeControllerApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes +[**delete_entity_computed_attributes**](ComputedAttributeControllerApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute +[**get_all_entities_computed_attributes**](ComputedAttributeControllerApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes +[**get_entity_computed_attributes**](ComputedAttributeControllerApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute +[**patch_entity_computed_attributes**](ComputedAttributeControllerApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute +[**search_entities_computed_attributes**](ComputedAttributeControllerApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +[**update_entity_computed_attributes**](ComputedAttributeControllerApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute + + +# **create_entity_computed_attributes** +> JsonApiComputedAttributeOutDocument create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document) + +Post Computed Attributes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_controller_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument +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 = computed_attribute_controller_api.ComputedAttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_computed_attribute_post_optional_id_document = JsonApiComputedAttributePostOptionalIdDocument( + data=JsonApiComputedAttributePostOptionalId( + attributes=JsonApiComputedAttributeInAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributePostOptionalIdDocument | + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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,origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Computed Attributes + api_response = api_instance.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->create_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Computed Attributes + api_response = api_instance.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->create_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_computed_attribute_post_optional_id_document** | [**JsonApiComputedAttributePostOptionalIdDocument**](JsonApiComputedAttributePostOptionalIdDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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_computed_attributes** +> delete_entity_computed_attributes(workspace_id, object_id) + +Delete a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_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 = computed_attribute_controller_api.ComputedAttributeControllerApi(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 Computed Attribute + api_instance.delete_entity_computed_attributes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->delete_entity_computed_attributes: %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_computed_attributes** +> JsonApiComputedAttributeOutList get_all_entities_computed_attributes(workspace_id) + +Get all Computed Attributes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_controller_api +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +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 = computed_attribute_controller_api.ComputedAttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=permissions,origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Computed Attributes + api_response = api_instance.get_all_entities_computed_attributes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->get_all_entities_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Computed Attributes + api_response = api_instance.get_all_entities_computed_attributes(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 ComputedAttributeControllerApi->get_all_entities_computed_attributes: %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 + +[**JsonApiComputedAttributeOutList**](JsonApiComputedAttributeOutList.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_computed_attributes** +> JsonApiComputedAttributeOutDocument get_entity_computed_attributes(workspace_id, object_id) + +Get a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_controller_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +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 = computed_attribute_controller_api.ComputedAttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Computed Attribute + api_response = api_instance.get_entity_computed_attributes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->get_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Computed Attribute + api_response = api_instance.get_entity_computed_attributes(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 ComputedAttributeControllerApi->get_entity_computed_attributes: %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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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_computed_attributes** +> JsonApiComputedAttributeOutDocument patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document) + +Patch a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_controller_api +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +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 = computed_attribute_controller_api.ComputedAttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_computed_attribute_patch_document = JsonApiComputedAttributePatchDocument( + data=JsonApiComputedAttributePatch( + attributes=JsonApiComputedAttributePatchAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributePatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Computed Attribute + api_response = api_instance.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->patch_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Computed Attribute + api_response = api_instance.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->patch_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_computed_attribute_patch_document** | [**JsonApiComputedAttributePatchDocument**](JsonApiComputedAttributePatchDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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) + +# **search_entities_computed_attributes** +> JsonApiComputedAttributeOutList search_entities_computed_attributes(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_controller_api +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = computed_attribute_controller_api.ComputedAttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->search_entities_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->search_entities_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiComputedAttributeOutList**](JsonApiComputedAttributeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**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_computed_attributes** +> JsonApiComputedAttributeOutDocument update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document) + +Put a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attribute_controller_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +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 = computed_attribute_controller_api.ComputedAttributeControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_computed_attribute_in_document = JsonApiComputedAttributeInDocument( + data=JsonApiComputedAttributeIn( + attributes=JsonApiComputedAttributeInAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributeInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Computed Attribute + api_response = api_instance.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->update_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Computed Attribute + api_response = api_instance.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributeControllerApi->update_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_computed_attribute_in_document** | [**JsonApiComputedAttributeInDocument**](JsonApiComputedAttributeInDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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/ComputedAttributePermissions.md b/gooddata-api-client/docs/ComputedAttributePermissions.md new file mode 100644 index 000000000..85eae94b5 --- /dev/null +++ b/gooddata-api-client/docs/ComputedAttributePermissions.md @@ -0,0 +1,14 @@ +# ComputedAttributePermissions + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rules** | [**[RulePermission]**](RulePermission.md) | List of rules | +**user_groups** | [**[UserGroupPermission]**](UserGroupPermission.md) | List of user groups | +**users** | [**[UserPermission]**](UserPermission.md) | List of users | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ComputedAttributePermissionsAssignment.md b/gooddata-api-client/docs/ComputedAttributePermissionsAssignment.md new file mode 100644 index 000000000..08bf1a609 --- /dev/null +++ b/gooddata-api-client/docs/ComputedAttributePermissionsAssignment.md @@ -0,0 +1,13 @@ +# ComputedAttributePermissionsAssignment + +Desired levels of permissions on a computed attribute for an assignee. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ComputedAttributePermissionsForAssignee.md b/gooddata-api-client/docs/ComputedAttributePermissionsForAssignee.md new file mode 100644 index 000000000..32de3a253 --- /dev/null +++ b/gooddata-api-client/docs/ComputedAttributePermissionsForAssignee.md @@ -0,0 +1,14 @@ +# ComputedAttributePermissionsForAssignee + +Desired levels of computed-attribute permissions for an assignee identified by an identifier. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ComputedAttributePermissionsForAssigneeRule.md b/gooddata-api-client/docs/ComputedAttributePermissionsForAssigneeRule.md new file mode 100644 index 000000000..245354dff --- /dev/null +++ b/gooddata-api-client/docs/ComputedAttributePermissionsForAssigneeRule.md @@ -0,0 +1,14 @@ +# ComputedAttributePermissionsForAssigneeRule + +Desired levels of computed-attribute permissions for a collection of assignees identified by a rule. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ComputedAttributesApi.md b/gooddata-api-client/docs/ComputedAttributesApi.md new file mode 100644 index 000000000..732e6e910 --- /dev/null +++ b/gooddata-api-client/docs/ComputedAttributesApi.md @@ -0,0 +1,690 @@ +# gooddata_api_client.ComputedAttributesApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_computed_attributes**](ComputedAttributesApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes +[**delete_entity_computed_attributes**](ComputedAttributesApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute +[**get_all_entities_computed_attributes**](ComputedAttributesApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes +[**get_entity_computed_attributes**](ComputedAttributesApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute +[**patch_entity_computed_attributes**](ComputedAttributesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute +[**search_entities_computed_attributes**](ComputedAttributesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) +[**update_entity_computed_attributes**](ComputedAttributesApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute + + +# **create_entity_computed_attributes** +> JsonApiComputedAttributeOutDocument create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document) + +Post Computed Attributes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument +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 = computed_attributes_api.ComputedAttributesApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_computed_attribute_post_optional_id_document = JsonApiComputedAttributePostOptionalIdDocument( + data=JsonApiComputedAttributePostOptionalId( + attributes=JsonApiComputedAttributeInAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributePostOptionalIdDocument | + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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,origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Computed Attributes + api_response = api_instance.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->create_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Computed Attributes + api_response = api_instance.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->create_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_computed_attribute_post_optional_id_document** | [**JsonApiComputedAttributePostOptionalIdDocument**](JsonApiComputedAttributePostOptionalIdDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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_computed_attributes** +> delete_entity_computed_attributes(workspace_id, object_id) + +Delete a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_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 = computed_attributes_api.ComputedAttributesApi(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 Computed Attribute + api_instance.delete_entity_computed_attributes(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->delete_entity_computed_attributes: %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_computed_attributes** +> JsonApiComputedAttributeOutList get_all_entities_computed_attributes(workspace_id) + +Get all Computed Attributes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_api +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +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 = computed_attributes_api.ComputedAttributesApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=permissions,origin,page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get all Computed Attributes + api_response = api_instance.get_all_entities_computed_attributes(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->get_all_entities_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Computed Attributes + api_response = api_instance.get_all_entities_computed_attributes(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 ComputedAttributesApi->get_all_entities_computed_attributes: %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 + +[**JsonApiComputedAttributeOutList**](JsonApiComputedAttributeOutList.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_computed_attributes** +> JsonApiComputedAttributeOutDocument get_entity_computed_attributes(workspace_id, object_id) + +Get a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +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 = computed_attributes_api.ComputedAttributesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Computed Attribute + api_response = api_instance.get_entity_computed_attributes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->get_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Computed Attribute + api_response = api_instance.get_entity_computed_attributes(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 ComputedAttributesApi->get_entity_computed_attributes: %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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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_computed_attributes** +> JsonApiComputedAttributeOutDocument patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document) + +Patch a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_api +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +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 = computed_attributes_api.ComputedAttributesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_computed_attribute_patch_document = JsonApiComputedAttributePatchDocument( + data=JsonApiComputedAttributePatch( + attributes=JsonApiComputedAttributePatchAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributePatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Computed Attribute + api_response = api_instance.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->patch_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Computed Attribute + api_response = api_instance.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->patch_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_computed_attribute_patch_document** | [**JsonApiComputedAttributePatchDocument**](JsonApiComputedAttributePatchDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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) + +# **search_entities_computed_attributes** +> JsonApiComputedAttributeOutList search_entities_computed_attributes(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_api +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = computed_attributes_api.ComputedAttributesApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->search_entities_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->search_entities_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiComputedAttributeOutList**](JsonApiComputedAttributeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**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_computed_attributes** +> JsonApiComputedAttributeOutDocument update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document) + +Put a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import computed_attributes_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +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 = computed_attributes_api.ComputedAttributesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_computed_attribute_in_document = JsonApiComputedAttributeInDocument( + data=JsonApiComputedAttributeIn( + attributes=JsonApiComputedAttributeInAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributeInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Computed Attribute + api_response = api_instance.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->update_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Computed Attribute + api_response = api_instance.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ComputedAttributesApi->update_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_computed_attribute_in_document** | [**JsonApiComputedAttributeInDocument**](JsonApiComputedAttributeInDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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/ConditionalFormatting.md b/gooddata-api-client/docs/ConditionalFormatting.md new file mode 100644 index 000000000..43caa08a1 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormatting.md @@ -0,0 +1,14 @@ +# ConditionalFormatting + +Conditional formatting for a table, with one entry per formatted column. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the rules are applied when rendering. | +**rules** | [**[ConditionalFormattingRule]**](ConditionalFormattingRule.md) | Rules evaluated in order; within a target, the first matching condition wins. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValue.md b/gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValue.md new file mode 100644 index 000000000..2fa94810c --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValue.md @@ -0,0 +1,15 @@ +# ConditionalFormattingAbsoluteDateValue + +A fixed, inclusive date period. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **str** | `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. | +**to** | **str** | `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive. | +**kind** | **str** | The value kind. | defaults to "absoluteDate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValueAllOf.md b/gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValueAllOf.md new file mode 100644 index 000000000..b67b4406c --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingAbsoluteDateValueAllOf.md @@ -0,0 +1,14 @@ +# ConditionalFormattingAbsoluteDateValueAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **str** | `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. | [optional] +**kind** | **str** | The value kind. | [optional] if omitted the server will use the default value of "absoluteDate" +**to** | **str** | `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive. | [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/ActiveObjectIdentification.md b/gooddata-api-client/docs/ConditionalFormattingAttributeTarget.md similarity index 67% rename from gooddata-api-client/docs/ActiveObjectIdentification.md rename to gooddata-api-client/docs/ConditionalFormattingAttributeTarget.md index d9a2475ae..dfbb320ed 100644 --- a/gooddata-api-client/docs/ActiveObjectIdentification.md +++ b/gooddata-api-client/docs/ConditionalFormattingAttributeTarget.md @@ -1,13 +1,12 @@ -# ActiveObjectIdentification +# ConditionalFormattingAttributeTarget -Object, with which the user is actively working. +An attribute column, addressed by its bucket item local identifier. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | Object ID. | -**type** | **str** | Object type, e.g. dashboard. | -**workspace_id** | **str** | Workspace ID. | +**attribute_identifier** | **str** | | +**kind** | **str** | The target kind. | defaults to "attribute" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ConditionalFormattingAttributeTargetAllOf.md b/gooddata-api-client/docs/ConditionalFormattingAttributeTargetAllOf.md new file mode 100644 index 000000000..57f42b10c --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingAttributeTargetAllOf.md @@ -0,0 +1,13 @@ +# ConditionalFormattingAttributeTargetAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_identifier** | **str** | | [optional] +**kind** | **str** | The target kind. | [optional] if omitted the server will use the default value of "attribute" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingCondition.md b/gooddata-api-client/docs/ConditionalFormattingCondition.md new file mode 100644 index 000000000..d28b917d1 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingCondition.md @@ -0,0 +1,16 @@ +# ConditionalFormattingCondition + +A condition and the formatting applied to cells matching it. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**format** | [**ConditionalFormattingFormat**](ConditionalFormattingFormat.md) | | +**operator** | **str** | How a condition compares the cell value against its value. | +**value** | [**ConditionalFormattingValue**](ConditionalFormattingValue.md) | | +**id** | **str** | Client-assigned identifier, stable across edits. | [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/DateTruncPartitionConfig.md b/gooddata-api-client/docs/ConditionalFormattingFormat.md similarity index 57% rename from gooddata-api-client/docs/DateTruncPartitionConfig.md rename to gooddata-api-client/docs/ConditionalFormattingFormat.md index 5069f1cf5..3b7db0a8a 100644 --- a/gooddata-api-client/docs/DateTruncPartitionConfig.md +++ b/gooddata-api-client/docs/ConditionalFormattingFormat.md @@ -1,13 +1,13 @@ -# DateTruncPartitionConfig +# ConditionalFormattingFormat -Partition by date_trunc() expression. +Visual formatting applied to a matching cell. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**column** | **str** | Column to partition on. | -**unit** | **str** | Date/time unit for partition granularity | -**type** | **str** | | defaults to "dateTrunc" +**scope** | **str** | Whether the formatting applies to the matching cell only, or to its whole row. | +**background_color** | **str** | Background color as a hex triplet. | [optional] +**color** | **str** | Text color as a hex triplet. | [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/DateAbsoluteFilter.md b/gooddata-api-client/docs/ConditionalFormattingLiteral.md similarity index 81% rename from gooddata-api-client/docs/DateAbsoluteFilter.md rename to gooddata-api-client/docs/ConditionalFormattingLiteral.md index 1bf764f33..2a7e4a48c 100644 --- a/gooddata-api-client/docs/DateAbsoluteFilter.md +++ b/gooddata-api-client/docs/ConditionalFormattingLiteral.md @@ -1,12 +1,10 @@ -# DateAbsoluteFilter +# ConditionalFormattingLiteral +A string or a number, serialized in whichever form it was authored. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**_from** | **str** | | -**to** | **str** | | -**using** | **str** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ConditionalFormattingLiteralRangeValue.md b/gooddata-api-client/docs/ConditionalFormattingLiteralRangeValue.md new file mode 100644 index 000000000..7652fecd4 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingLiteralRangeValue.md @@ -0,0 +1,15 @@ +# ConditionalFormattingLiteralRangeValue + +An inclusive numeric range. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **float** | | +**to** | **float** | | +**kind** | **str** | The value kind. | defaults to "literalRange" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingLiteralRangeValueAllOf.md b/gooddata-api-client/docs/ConditionalFormattingLiteralRangeValueAllOf.md new file mode 100644 index 000000000..9252185fa --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingLiteralRangeValueAllOf.md @@ -0,0 +1,14 @@ +# ConditionalFormattingLiteralRangeValueAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **float** | | [optional] +**kind** | **str** | The value kind. | [optional] if omitted the server will use the default value of "literalRange" +**to** | **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/AggregateKeyConfig.md b/gooddata-api-client/docs/ConditionalFormattingLiteralValue.md similarity index 65% rename from gooddata-api-client/docs/AggregateKeyConfig.md rename to gooddata-api-client/docs/ConditionalFormattingLiteralValue.md index ae0248dc0..bd94d09ce 100644 --- a/gooddata-api-client/docs/AggregateKeyConfig.md +++ b/gooddata-api-client/docs/ConditionalFormattingLiteralValue.md @@ -1,12 +1,12 @@ -# AggregateKeyConfig +# ConditionalFormattingLiteralValue -Aggregate key model — pre-aggregates rows sharing the same key columns. +A single value compared against the cell value. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "aggregate" -**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] +**value** | [**ConditionalFormattingLiteral**](ConditionalFormattingLiteral.md) | | +**kind** | **str** | The value kind. | defaults to "literal" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/ConditionalFormattingLiteralValueAllOf.md b/gooddata-api-client/docs/ConditionalFormattingLiteralValueAllOf.md new file mode 100644 index 000000000..c8a951351 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingLiteralValueAllOf.md @@ -0,0 +1,13 @@ +# ConditionalFormattingLiteralValueAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **str** | The value kind. | [optional] if omitted the server will use the default value of "literal" +**value** | [**ConditionalFormattingLiteral**](ConditionalFormattingLiteral.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/ConditionalFormattingMeasureTarget.md b/gooddata-api-client/docs/ConditionalFormattingMeasureTarget.md new file mode 100644 index 000000000..152e11367 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingMeasureTarget.md @@ -0,0 +1,14 @@ +# ConditionalFormattingMeasureTarget + +A measure column, addressed by its bucket item local identifier. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**measure_identifier** | **str** | | +**kind** | **str** | The target kind. | defaults to "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/ConditionalFormattingMeasureTargetAllOf.md b/gooddata-api-client/docs/ConditionalFormattingMeasureTargetAllOf.md new file mode 100644 index 000000000..6998ca78f --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingMeasureTargetAllOf.md @@ -0,0 +1,13 @@ +# ConditionalFormattingMeasureTargetAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **str** | The target kind. | [optional] if omitted the server will use the default value of "measure" +**measure_identifier** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingNoneValue.md b/gooddata-api-client/docs/ConditionalFormattingNoneValue.md new file mode 100644 index 000000000..37ad84ca2 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingNoneValue.md @@ -0,0 +1,13 @@ +# ConditionalFormattingNoneValue + +No value; used by operators that take none. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **str** | The value kind. | defaults to "none" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingNoneValueAllOf.md b/gooddata-api-client/docs/ConditionalFormattingNoneValueAllOf.md new file mode 100644 index 000000000..c72e7b4b8 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingNoneValueAllOf.md @@ -0,0 +1,12 @@ +# ConditionalFormattingNoneValueAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **str** | The value kind. | [optional] if omitted the server will use the default value of "none" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingRelativeDateValue.md b/gooddata-api-client/docs/ConditionalFormattingRelativeDateValue.md new file mode 100644 index 000000000..872e29561 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingRelativeDateValue.md @@ -0,0 +1,16 @@ +# ConditionalFormattingRelativeDateValue + +A date period relative to the moment of evaluation, resolved at render time. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **int** | Offset in periods; 0 is the current period, negative is the past. | +**granularity** | **str** | Granularity the offsets are counted in. | +**to** | **int** | Offset in periods, not lower than `from`. | +**kind** | **str** | The value kind. | defaults to "relativeDate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingRelativeDateValueAllOf.md b/gooddata-api-client/docs/ConditionalFormattingRelativeDateValueAllOf.md new file mode 100644 index 000000000..b976ec5e8 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingRelativeDateValueAllOf.md @@ -0,0 +1,15 @@ +# ConditionalFormattingRelativeDateValueAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_from** | **int** | Offset in periods; 0 is the current period, negative is the past. | [optional] +**granularity** | **str** | Granularity the offsets are counted in. | [optional] +**kind** | **str** | The value kind. | [optional] if omitted the server will use the default value of "relativeDate" +**to** | **int** | Offset in periods, not lower than `from`. | [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/ConditionalFormattingRule.md b/gooddata-api-client/docs/ConditionalFormattingRule.md new file mode 100644 index 000000000..a5bcb0d20 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingRule.md @@ -0,0 +1,15 @@ +# ConditionalFormattingRule + +Conditions applied to a single column. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conditions** | [**[ConditionalFormattingCondition]**](ConditionalFormattingCondition.md) | Conditions evaluated in order; the first match wins. | +**target** | [**ConditionalFormattingTarget**](ConditionalFormattingTarget.md) | | +**id** | **str** | Client-assigned identifier, stable across edits. | [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/ConditionalFormattingTarget.md b/gooddata-api-client/docs/ConditionalFormattingTarget.md new file mode 100644 index 000000000..3eb382baa --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingTarget.md @@ -0,0 +1,15 @@ +# ConditionalFormattingTarget + +Column a rule formats. The shape is selected by the `kind` property. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attribute_identifier** | **str** | | [optional] +**kind** | **str** | The target kind. | [optional] if omitted the server will use the default value of "measure" +**measure_identifier** | **str** | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ConditionalFormattingValue.md b/gooddata-api-client/docs/ConditionalFormattingValue.md new file mode 100644 index 000000000..8ee519c44 --- /dev/null +++ b/gooddata-api-client/docs/ConditionalFormattingValue.md @@ -0,0 +1,17 @@ +# ConditionalFormattingValue + +Value a condition compares against. The shape is selected by the `kind` property. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kind** | **str** | The value kind. | [optional] if omitted the server will use the default value of "relativeDate" +**value** | [**ConditionalFormattingLiteral**](ConditionalFormattingLiteral.md) | | [optional] +**_from** | **int** | Offset in periods; 0 is the current period, negative is the past. | [optional] +**to** | **int** | Offset in periods, not lower than `from`. | [optional] +**granularity** | **str** | Granularity the offsets are counted in. | [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/CreatePipeTableRequest.md b/gooddata-api-client/docs/CreatePipeTableRequest.md deleted file mode 100644 index edc2d4cef..000000000 --- a/gooddata-api-client/docs/CreatePipeTableRequest.md +++ /dev/null @@ -1,24 +0,0 @@ -# CreatePipeTableRequest - -Request to create a new pipe-backed OLAP table in the AI Lake - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**path_prefix** | **str** | Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported. | -**source_storage_name** | **str** | Name of the pre-configured S3/MinIO ObjectStorage source | -**table_name** | **str** | Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$ | -**aggregation_overrides** | **{str: (str,)}** | Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types. | [optional] -**column_expressions** | [**{str: (ColumnExpression,)}**](ColumnExpression.md) | Per-target-column projection overrides. Each entry emits `<function>(<column>) AS <key>` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns). | [optional] -**column_overrides** | **{str: (str,)}** | Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference. | [optional] -**distribution_config** | [**CreatePipeTableRequestDistributionConfig**](CreatePipeTableRequestDistributionConfig.md) | | [optional] -**key_config** | [**CreatePipeTableRequestKeyConfig**](CreatePipeTableRequestKeyConfig.md) | | [optional] -**max_varchar_length** | **int** | Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap. | [optional] -**partition_config** | [**CreatePipeTableRequestPartitionConfig**](CreatePipeTableRequestPartitionConfig.md) | | [optional] -**polling_interval_seconds** | **int** | How often (in seconds) the pipe polls for new files. 0 or null = use server default. | [optional] -**table_properties** | **{str: (str,)}** | CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md b/gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md deleted file mode 100644 index 9a6e14e19..000000000 --- a/gooddata-api-client/docs/CreatePipeTableRequestDistributionConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreatePipeTableRequestDistributionConfig - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**buckets** | **int** | Number of random distribution buckets. Defaults to 1. | [optional] -**columns** | **[str]** | Columns to distribute by. Defaults to first column. | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "random" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md b/gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md deleted file mode 100644 index 5ba2ee78e..000000000 --- a/gooddata-api-client/docs/CreatePipeTableRequestKeyConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# CreatePipeTableRequestKeyConfig - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "unique" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md b/gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md deleted file mode 100644 index 0703702f3..000000000 --- a/gooddata-api-client/docs/CreatePipeTableRequestPartitionConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# CreatePipeTableRequestPartitionConfig - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | **[str]** | Columns to partition by. | [optional] -**type** | **str** | | [optional] if omitted the server will use the default value of "timeSlice" -**column** | **str** | Column to partition on. | [optional] -**unit** | **str** | Date/time unit for partition granularity | [optional] -**slices** | **int** | How many units per slice. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/CreatedVisualization.md b/gooddata-api-client/docs/CreatedVisualization.md deleted file mode 100644 index fc05128df..000000000 --- a/gooddata-api-client/docs/CreatedVisualization.md +++ /dev/null @@ -1,21 +0,0 @@ -# CreatedVisualization - -List of created visualization objects - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dimensionality** | [**[DimAttribute]**](DimAttribute.md) | List of attributes representing the dimensionality of the new visualization | -**filters** | [**[CreatedVisualizationFiltersInner]**](CreatedVisualizationFiltersInner.md) | List of filters to be applied to the new visualization | -**id** | **str** | Proposed ID of the new visualization | -**metrics** | [**[Metric]**](Metric.md) | List of metrics to be used in the new visualization | -**suggestions** | [**[Suggestion]**](Suggestion.md) | Suggestions for next steps | -**title** | **str** | Proposed title of the new visualization | -**visualization_type** | **str** | Visualization type requested in question | -**config** | [**VisualizationConfig**](VisualizationConfig.md) | | [optional] -**saved_visualization_id** | **str** | Saved visualization ID. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md b/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md deleted file mode 100644 index 7f6c7d855..000000000 --- a/gooddata-api-client/docs/CreatedVisualizationFiltersInner.md +++ /dev/null @@ -1,21 +0,0 @@ -# CreatedVisualizationFiltersInner - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dimensionality** | **[str]** | | [optional] -**exclude** | **[str]** | | [optional] -**using** | **str** | | [optional] -**include** | **[str]** | | [optional] -**_from** | **int** | | [optional] -**to** | **int** | | [optional] -**granularity** | **str** | | [optional] -**measures** | **[str]** | | [optional] -**operator** | **str** | | [optional] -**value** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/CreatedVisualizations.md b/gooddata-api-client/docs/CreatedVisualizations.md deleted file mode 100644 index b2ad1baeb..000000000 --- a/gooddata-api-client/docs/CreatedVisualizations.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreatedVisualizations - -Visualization definitions created by AI. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**objects** | [**[CreatedVisualization]**](CreatedVisualization.md) | List of created visualization objects | -**reasoning** | **str** | DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. | -**suggestions** | [**[Suggestion]**](Suggestion.md) | List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DashboardContext.md b/gooddata-api-client/docs/DashboardContext.md deleted file mode 100644 index 71b9c16a2..000000000 --- a/gooddata-api-client/docs/DashboardContext.md +++ /dev/null @@ -1,14 +0,0 @@ -# DashboardContext - -Dashboard the user is currently viewing. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Dashboard object ID. | -**widgets** | [**[WidgetDescriptor]**](WidgetDescriptor.md) | Widgets currently visible on the dashboard. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DashboardsApi.md b/gooddata-api-client/docs/DashboardsApi.md index 5a8c50016..5f0a7d25f 100644 --- a/gooddata-api-client/docs/DashboardsApi.md +++ b/gooddata-api-client/docs/DashboardsApi.md @@ -57,7 +57,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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,origin,accessInfo,all", @@ -207,7 +207,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -303,7 +303,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -408,7 +408,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAnalyticalDashboardPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -607,7 +607,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAnalyticalDashboardInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/DataFiltersApi.md b/gooddata-api-client/docs/DataFiltersApi.md index beaa70784..4541bf700 100644 --- a/gooddata-api-client/docs/DataFiltersApi.md +++ b/gooddata-api-client/docs/DataFiltersApi.md @@ -80,7 +80,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiUserDataFilterPostOptionalIdDocument | include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -567,7 +567,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -855,7 +855,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -1206,7 +1206,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiUserDataFilterPatchDocument | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -1908,7 +1908,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiUserDataFilterInDocument | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/DataSourceControllerApi.md b/gooddata-api-client/docs/DataSourceControllerApi.md index 1989010eb..3d1e74e5b 100644 --- a/gooddata-api-client/docs/DataSourceControllerApi.md +++ b/gooddata-api-client/docs/DataSourceControllerApi.md @@ -50,6 +50,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -388,6 +389,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -498,6 +500,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( diff --git a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md index b31c0b27f..00585613c 100644 --- a/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceDeclarativeAPIsApi.md @@ -114,6 +114,7 @@ with gooddata_api_client.ApiClient() as api_client: value="value_example", ), ], + disable_statistics=True, id="pg_local_docker-demo", name="postgres demo", parameters=[ diff --git a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md index 03204c83d..aa1d387e6 100644 --- a/gooddata-api-client/docs/DataSourceEntityAPIsApi.md +++ b/gooddata-api-client/docs/DataSourceEntityAPIsApi.md @@ -52,6 +52,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -548,6 +549,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -658,6 +660,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( diff --git a/gooddata-api-client/docs/DataSourceStatisticsApi.md b/gooddata-api-client/docs/DataSourceStatisticsApi.md index 704156bcd..9d34522b9 100644 --- a/gooddata-api-client/docs/DataSourceStatisticsApi.md +++ b/gooddata-api-client/docs/DataSourceStatisticsApi.md @@ -7,7 +7,7 @@ Method | HTTP request | Description [**delete_data_source_statistics**](DataSourceStatisticsApi.md#delete_data_source_statistics) | **DELETE** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Delete stored physical statistics for a data source [**get_data_source_statistics**](DataSourceStatisticsApi.md#get_data_source_statistics) | **GET** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Retrieve stored physical statistics for a data source [**put_data_source_statistics**](DataSourceStatisticsApi.md#put_data_source_statistics) | **PUT** /api/v1/layout/dataSources/{dataSourceId}/statistics | (BETA) Store physical table and column statistics for a data source -[**scan_statistics**](DataSourceStatisticsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a StarRocks data source +[**scan_statistics**](DataSourceStatisticsApi.md#scan_statistics) | **POST** /api/v1/actions/dataSources/{dataSourceId}/scanStatistics | (BETA) Collect physical table and column statistics from a data source # **delete_data_source_statistics** @@ -245,9 +245,9 @@ No authorization required # **scan_statistics** > TableStatisticsResponse scan_statistics(data_source_id, table_statistics_request) -(BETA) Collect physical table and column statistics from a StarRocks data source +(BETA) Collect physical table and column statistics from a data source -(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values. +(BETA) Reads the statistics the database already maintains in its own catalog, without scanning any data. Supported for StarRocks (both internal catalog for native/PIPE tables and external catalog for Iceberg tables), BigQuery, PostgreSQL, Redshift, Snowflake, Vertica, SQL Server, Azure SQL, MySQL, MariaDB and SingleStore. Statistics include row counts and data sizes, and, where the database exposes them, NDV (number of distinct values), null counts and min/max values. Returns an empty result for a data source whose database exposes no such catalog. Also returns an empty result for a data source that sets disableStatistics. ### Example @@ -282,7 +282,7 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # (BETA) Collect physical table and column statistics from a StarRocks data source + # (BETA) Collect physical table and column statistics from a data source api_response = api_instance.scan_statistics(data_source_id, table_statistics_request) pprint(api_response) except gooddata_api_client.ApiException as e: diff --git a/gooddata-api-client/docs/DatasetControllerApi.md b/gooddata-api-client/docs/DatasetControllerApi.md index 6886b46c2..e09ccb0be 100644 --- a/gooddata-api-client/docs/DatasetControllerApi.md +++ b/gooddata-api-client/docs/DatasetControllerApi.md @@ -224,7 +224,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_dataset_patch_document = JsonApiDatasetPatchDocument( data=JsonApiDatasetPatch( - attributes=JsonApiAttributePatchAttributes( + attributes=JsonApiDatasetPatchAttributes( description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/DatasetsApi.md b/gooddata-api-client/docs/DatasetsApi.md index 1fc72d619..08d5ab1fc 100644 --- a/gooddata-api-client/docs/DatasetsApi.md +++ b/gooddata-api-client/docs/DatasetsApi.md @@ -224,7 +224,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_dataset_patch_document = JsonApiDatasetPatchDocument( data=JsonApiDatasetPatch( - attributes=JsonApiAttributePatchAttributes( + attributes=JsonApiDatasetPatchAttributes( description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/DateAbsoluteFilterAllOf.md b/gooddata-api-client/docs/DateAbsoluteFilterAllOf.md deleted file mode 100644 index 015445d70..000000000 --- a/gooddata-api-client/docs/DateAbsoluteFilterAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# DateAbsoluteFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_from** | **str** | | [optional] -**to** | **str** | | [optional] -**using** | **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/DateRelativeFilter.md b/gooddata-api-client/docs/DateRelativeFilter.md deleted file mode 100644 index 651d60b2f..000000000 --- a/gooddata-api-client/docs/DateRelativeFilter.md +++ /dev/null @@ -1,15 +0,0 @@ -# DateRelativeFilter - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_from** | **int** | | -**granularity** | **str** | | -**to** | **int** | | -**using** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DateRelativeFilterAllOf.md b/gooddata-api-client/docs/DateRelativeFilterAllOf.md deleted file mode 100644 index 9697c791e..000000000 --- a/gooddata-api-client/docs/DateRelativeFilterAllOf.md +++ /dev/null @@ -1,15 +0,0 @@ -# DateRelativeFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**_from** | **int** | | [optional] -**granularity** | **str** | | [optional] -**to** | **int** | | [optional] -**using** | **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/DeclarativeAgent.md b/gooddata-api-client/docs/DeclarativeAgent.md index 976649531..e98ef8008 100644 --- a/gooddata-api-client/docs/DeclarativeAgent.md +++ b/gooddata-api-client/docs/DeclarativeAgent.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **custom_skills** | **[str]** | List of custom skills when skillsMode is CUSTOM. | [optional] **description** | **str** | Description of the agent. | [optional] **enabled** | **bool** | Whether the agent is enabled. | [optional] +**instructions** | [**[Instruction], none_type**](Instruction.md) | Rules this agent follows when answering. | [optional] **modified_at** | **str, none_type** | Time of the last entity modification. | [optional] **modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **name** | **str** | Name of the agent. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md index d03823f21..9f5fe7992 100644 --- a/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md +++ b/gooddata-api-client/docs/DeclarativeAnalyticsLayer.md @@ -7,12 +7,16 @@ Name | Type | Description | Notes **analytical_dashboard_extensions** | [**[DeclarativeAnalyticalDashboardExtension]**](DeclarativeAnalyticalDashboardExtension.md) | A list of dashboard permissions assigned to a related dashboard. | [optional] **analytical_dashboards** | [**[DeclarativeAnalyticalDashboard]**](DeclarativeAnalyticalDashboard.md) | A list of analytical dashboards available in the model. | [optional] **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] **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] **parameters** | [**[DeclarativeParameter]**](DeclarativeParameter.md) | A list of parameters available in the model. | [optional] +**report_page_layouts** | [**[DeclarativeReportPageLayout]**](DeclarativeReportPageLayout.md) | A list of report page layouts available in the model. | [optional] +**report_templates** | [**[DeclarativeReportTemplate]**](DeclarativeReportTemplate.md) | A list of report templates available in the model. | [optional] +**reports** | [**[DeclarativeReport]**](DeclarativeReport.md) | A list of reports available in the model. | [optional] **visualization_objects** | [**[DeclarativeVisualizationObject]**](DeclarativeVisualizationObject.md) | A list of visualization objects available in the model. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/DeclarativeAttribute.md b/gooddata-api-client/docs/DeclarativeAttribute.md index 7bf22e645..c85511826 100644 --- a/gooddata-api-client/docs/DeclarativeAttribute.md +++ b/gooddata-api-client/docs/DeclarativeAttribute.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **id** | **str** | Attribute ID. | **labels** | [**[DeclarativeLabel]**](DeclarativeLabel.md) | An array of attribute labels. | **title** | **str** | Attribute title. | +**conditional_formatting** | [**ObjectConditionalFormatting**](ObjectConditionalFormatting.md) | | [optional] **default_view** | [**LabelIdentifier**](LabelIdentifier.md) | | [optional] **description** | **str** | Attribute description. | [optional] **is_hidden** | **bool** | If true, this attribute is hidden from AI search results. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeComputedAttribute.md b/gooddata-api-client/docs/DeclarativeComputedAttribute.md new file mode 100644 index 000000000..710b26170 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeComputedAttribute.md @@ -0,0 +1,30 @@ +# DeclarativeComputedAttribute + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**DeclarativeComputedAttributeContent**](DeclarativeComputedAttributeContent.md) | | +**id** | **str** | Computed attribute ID. | +**title** | **str** | Computed attribute title. | +**certification** | **str** | Certification status of the entity. | [optional] if omitted the server will use the default value of "CERTIFIED" +**certification_message** | **str, none_type** | Optional message associated with the certification. | [optional] +**certified_at** | **str, none_type** | Time when the certification was set. | [optional] +**certified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**created_at** | **str, none_type** | Time of the entity creation. | [optional] +**created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**data_type** | **str** | Computed attribute data type | [optional] +**description** | **str** | Computed attribute description. | [optional] +**is_hidden** | **bool** | If true, this computed attribute is hidden from AI search results. | [optional] +**is_nullable** | **bool** | Flag indicating whether the associated source column allows null values. | [optional] +**locale** | **str** | Default locale for primary computed label. | [optional] +**modified_at** | **str, none_type** | Time of the last entity modification. | [optional] +**modified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**null_value** | **str** | Value used in coalesce during joins instead of null. | [optional] +**tags** | **[str]** | A list of tags. | [optional] +**value_type** | **str** | Specific type of the computed attribute 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/DeclarativeComputedAttributeContent.md b/gooddata-api-client/docs/DeclarativeComputedAttributeContent.md new file mode 100644 index 000000000..87b7cadea --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeComputedAttributeContent.md @@ -0,0 +1,15 @@ +# DeclarativeComputedAttributeContent + +A definition of the computed attribute content. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maql** | **str** | | +**format** | **str, none_type** | Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:<label_id>] for raw filter value passthrough. Currency tokens: [$CURRENCY:<label_id>] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values. | [optional] +**metric_type** | **str** | Categorizes metric semantics (e.g., currency). | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DeclarativeDataSource.md b/gooddata-api-client/docs/DeclarativeDataSource.md index 4f23fee45..f6f9d560d 100644 --- a/gooddata-api-client/docs/DeclarativeDataSource.md +++ b/gooddata-api-client/docs/DeclarativeDataSource.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **client_secret** | **str** | The client secret to use to connect to the database providing the data for the data source. | [optional] **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] **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/DeclarativeDateDataset.md b/gooddata-api-client/docs/DeclarativeDateDataset.md index 606945cc1..40371baf2 100644 --- a/gooddata-api-client/docs/DeclarativeDateDataset.md +++ b/gooddata-api-client/docs/DeclarativeDateDataset.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **granularities_formatting** | [**GranularitiesFormatting**](GranularitiesFormatting.md) | | **id** | **str** | Date dataset ID. | **title** | **str** | Date dataset title. | +**conditional_formatting** | [**ObjectConditionalFormatting**](ObjectConditionalFormatting.md) | | [optional] **description** | **str** | Date dataset description. | [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/DeclarativeLabel.md b/gooddata-api-client/docs/DeclarativeLabel.md index 6dea5bece..75486262c 100644 --- a/gooddata-api-client/docs/DeclarativeLabel.md +++ b/gooddata-api-client/docs/DeclarativeLabel.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Label ID. | **title** | **str** | Label title. | +**conditional_formatting** | [**ObjectConditionalFormatting**](ObjectConditionalFormatting.md) | | [optional] **description** | **str** | Label description. | [optional] **geo_area_config** | [**GeoAreaConfig**](GeoAreaConfig.md) | | [optional] **is_hidden** | **bool** | Determines if the label is hidden from AI features. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeMetric.md b/gooddata-api-client/docs/DeclarativeMetric.md index a068affcd..fa04e12e0 100644 --- a/gooddata-api-client/docs/DeclarativeMetric.md +++ b/gooddata-api-client/docs/DeclarativeMetric.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **certification_message** | **str, none_type** | Optional message associated with the certification. | [optional] **certified_at** | **str, none_type** | Time when the certification was set. | [optional] **certified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**conditional_formatting** | [**ObjectConditionalFormatting**](ObjectConditionalFormatting.md) | | [optional] **created_at** | **str, none_type** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Metric description. | [optional] diff --git a/gooddata-api-client/docs/DeclarativeReport.md b/gooddata-api-client/docs/DeclarativeReport.md new file mode 100644 index 000000000..ed7b433f8 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeReport.md @@ -0,0 +1,19 @@ +# DeclarativeReport + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonNode**](JsonNode.md) | | +**id** | **str** | Report ID. | +**period_end** | **date** | Last day of the reported period, inclusive. | +**period_start** | **date** | First day of the reported period, inclusive. | +**title** | **str** | Report title. | +**description** | **str** | Report description. | [optional] +**tags** | **[str]** | | [optional] +**variable_values** | **{str: (str,)}** | Values for the variables declared in the content, keyed by name. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/DeclarativeReportPageLayout.md b/gooddata-api-client/docs/DeclarativeReportPageLayout.md new file mode 100644 index 000000000..87ac2ff6c --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeReportPageLayout.md @@ -0,0 +1,16 @@ +# DeclarativeReportPageLayout + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonNode**](JsonNode.md) | | +**id** | **str** | Report page layout ID. | +**title** | **str** | Report page layout title. | +**description** | **str** | Report page layout 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/DeclarativeReportTemplate.md b/gooddata-api-client/docs/DeclarativeReportTemplate.md new file mode 100644 index 000000000..b7136c151 --- /dev/null +++ b/gooddata-api-client/docs/DeclarativeReportTemplate.md @@ -0,0 +1,16 @@ +# DeclarativeReportTemplate + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonNode**](JsonNode.md) | | +**id** | **str** | Report template ID. | +**title** | **str** | Report template title. | +**description** | **str** | Report 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/DeclarativeVisualizationObject.md b/gooddata-api-client/docs/DeclarativeVisualizationObject.md index 1a91a583e..9db8ab3b2 100644 --- a/gooddata-api-client/docs/DeclarativeVisualizationObject.md +++ b/gooddata-api-client/docs/DeclarativeVisualizationObject.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **certification_message** | **str, none_type** | Optional message associated with the certification. | [optional] **certified_at** | **str, none_type** | Time when the certification was set. | [optional] **certified_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] +**conditional_formatting** | [**ConditionalFormatting**](ConditionalFormatting.md) | | [optional] **created_at** | **str, none_type** | Time of the entity creation. | [optional] **created_by** | [**DeclarativeUserIdentifier**](DeclarativeUserIdentifier.md) | | [optional] **description** | **str** | Visualization object description. | [optional] diff --git a/gooddata-api-client/docs/DependsOn.md b/gooddata-api-client/docs/DependsOn.md index fc63f0064..cd5264353 100644 --- a/gooddata-api-client/docs/DependsOn.md +++ b/gooddata-api-client/docs/DependsOn.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **label** | **str** | Specifies on which label the filter depends on. | **values** | **[str, none_type]** | Specifies values of the label for element filtering. | **complement_filter** | **bool** | Inverse filtering mode. | [optional] if omitted the server will use the default value of False +**type** | **str** | Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback. | [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/DependsOnAllOf.md b/gooddata-api-client/docs/DependsOnAllOf.md index 71120ad8d..fb2879650 100644 --- a/gooddata-api-client/docs/DependsOnAllOf.md +++ b/gooddata-api-client/docs/DependsOnAllOf.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **complement_filter** | **bool** | Inverse filtering mode. | [optional] if omitted the server will use the default value of False **label** | **str** | Specifies on which label the filter depends on. | [optional] +**type** | **str** | Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback. | [optional] **values** | **[str, none_type]** | Specifies values of the label for element filtering. | [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/DimAttribute.md b/gooddata-api-client/docs/DimAttribute.md deleted file mode 100644 index f080b11da..000000000 --- a/gooddata-api-client/docs/DimAttribute.md +++ /dev/null @@ -1,15 +0,0 @@ -# DimAttribute - -List of attributes representing the dimensionality of the new visualization - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | ID of the object | -**title** | **str** | Title of attribute. | -**type** | **str** | Object type | defaults to "attribute" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DistributionConfig.md b/gooddata-api-client/docs/DistributionConfig.md deleted file mode 100644 index 85ac63472..000000000 --- a/gooddata-api-client/docs/DistributionConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# DistributionConfig - -Distribution configuration for the OLAP table. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/DuplicateKeyConfig.md b/gooddata-api-client/docs/DuplicateKeyConfig.md deleted file mode 100644 index 153ab4cae..000000000 --- a/gooddata-api-client/docs/DuplicateKeyConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# DuplicateKeyConfig - -Duplicate key model — allows duplicate rows for the given key columns. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "duplicate" -**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ElementsRequest.md b/gooddata-api-client/docs/ElementsRequest.md index e27fa7257..5105f7f50 100644 --- a/gooddata-api-client/docs/ElementsRequest.md +++ b/gooddata-api-client/docs/ElementsRequest.md @@ -15,6 +15,7 @@ Name | Type | Description | Notes **pattern_filter** | **str** | Return only items, whose ```label``` title case insensitively contains ```filter``` as substring. | [optional] **sort_order** | **str** | Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default | [optional] **timezone** | **str** | Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used. | [optional] +**type** | **str** | Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback. | [optional] **validate_by** | [**[ValidateByItem]**](ValidateByItem.md) | Return only items that are computable on metric. | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/ElementsRequestDependsOnInner.md b/gooddata-api-client/docs/ElementsRequestDependsOnInner.md index 1a1f4fe8e..8ccf23958 100644 --- a/gooddata-api-client/docs/ElementsRequestDependsOnInner.md +++ b/gooddata-api-client/docs/ElementsRequestDependsOnInner.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **complement_filter** | **bool** | Inverse filtering mode. | [optional] if omitted the server will use the default value of False +**type** | **str** | Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback. | [optional] **label** | **str** | Specifies on which label the filter depends on. | [optional] **values** | **[str, none_type]** | Specifies values of the label for element filtering. | [optional] **date_filter** | [**DateFilter**](DateFilter.md) | | [optional] diff --git a/gooddata-api-client/docs/EntitiesApi.md b/gooddata-api-client/docs/EntitiesApi.md index 8e2d895a4..4a6cbad47 100644 --- a/gooddata-api-client/docs/EntitiesApi.md +++ b/gooddata-api-client/docs/EntitiesApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description [**create_entity_attribute_hierarchies**](EntitiesApi.md#create_entity_attribute_hierarchies) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies | Post Attribute Hierarchies [**create_entity_automations**](EntitiesApi.md#create_entity_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations | Post Automations [**create_entity_color_palettes**](EntitiesApi.md#create_entity_color_palettes) | **POST** /api/v1/entities/colorPalettes | Post Color Pallettes +[**create_entity_computed_attributes**](EntitiesApi.md#create_entity_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Post Computed Attributes [**create_entity_csp_directives**](EntitiesApi.md#create_entity_csp_directives) | **POST** /api/v1/entities/cspDirectives | Post CSP Directives [**create_entity_custom_application_settings**](EntitiesApi.md#create_entity_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Post Custom Application Settings [**create_entity_custom_geo_collections**](EntitiesApi.md#create_entity_custom_geo_collections) | **POST** /api/v1/entities/customGeoCollections | Post Custom Geo Collections @@ -32,6 +33,9 @@ Method | HTTP request | Description [**create_entity_org_memory_items**](EntitiesApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities [**create_entity_organization_settings**](EntitiesApi.md#create_entity_organization_settings) | **POST** /api/v1/entities/organizationSettings | Post Organization Setting entities [**create_entity_parameters**](EntitiesApi.md#create_entity_parameters) | **POST** /api/v1/entities/workspaces/{workspaceId}/parameters | Post Parameters +[**create_entity_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 +[**create_entity_reports**](EntitiesApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report [**create_entity_themes**](EntitiesApi.md#create_entity_themes) | **POST** /api/v1/entities/themes | Post Theming [**create_entity_user_data_filters**](EntitiesApi.md#create_entity_user_data_filters) | **POST** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Post User Data Filters [**create_entity_user_groups**](EntitiesApi.md#create_entity_user_groups) | **POST** /api/v1/entities/userGroups | Post User Group entities @@ -52,6 +56,7 @@ Method | HTTP request | Description [**delete_entity_attribute_hierarchies**](EntitiesApi.md#delete_entity_attribute_hierarchies) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Delete an Attribute Hierarchy [**delete_entity_automations**](EntitiesApi.md#delete_entity_automations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Delete an Automation [**delete_entity_color_palettes**](EntitiesApi.md#delete_entity_color_palettes) | **DELETE** /api/v1/entities/colorPalettes/{id} | Delete a Color Pallette +[**delete_entity_computed_attributes**](EntitiesApi.md#delete_entity_computed_attributes) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Delete a Computed Attribute [**delete_entity_csp_directives**](EntitiesApi.md#delete_entity_csp_directives) | **DELETE** /api/v1/entities/cspDirectives/{id} | Delete CSP Directives [**delete_entity_custom_application_settings**](EntitiesApi.md#delete_entity_custom_application_settings) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Delete a Custom Application Setting [**delete_entity_custom_geo_collections**](EntitiesApi.md#delete_entity_custom_geo_collections) | **DELETE** /api/v1/entities/customGeoCollections/{id} | Delete Custom Geo Collection @@ -73,6 +78,9 @@ Method | HTTP request | Description [**delete_entity_org_memory_items**](EntitiesApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity [**delete_entity_organization_settings**](EntitiesApi.md#delete_entity_organization_settings) | **DELETE** /api/v1/entities/organizationSettings/{id} | Delete Organization Setting entity [**delete_entity_parameters**](EntitiesApi.md#delete_entity_parameters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Delete a Parameter +[**delete_entity_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 +[**delete_entity_reports**](EntitiesApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report [**delete_entity_themes**](EntitiesApi.md#delete_entity_themes) | **DELETE** /api/v1/entities/themes/{id} | Delete Theming [**delete_entity_user_data_filters**](EntitiesApi.md#delete_entity_user_data_filters) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Delete a User Data Filter [**delete_entity_user_groups**](EntitiesApi.md#delete_entity_user_groups) | **DELETE** /api/v1/entities/userGroups/{id} | Delete UserGroup entity @@ -96,6 +104,7 @@ Method | HTTP request | Description [**get_all_entities_attributes**](EntitiesApi.md#get_all_entities_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes | Get all Attributes [**get_all_entities_automations**](EntitiesApi.md#get_all_entities_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations | Get all Automations [**get_all_entities_color_palettes**](EntitiesApi.md#get_all_entities_color_palettes) | **GET** /api/v1/entities/colorPalettes | Get all Color Pallettes +[**get_all_entities_computed_attributes**](EntitiesApi.md#get_all_entities_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes | Get all Computed Attributes [**get_all_entities_csp_directives**](EntitiesApi.md#get_all_entities_csp_directives) | **GET** /api/v1/entities/cspDirectives | Get CSP Directives [**get_all_entities_custom_application_settings**](EntitiesApi.md#get_all_entities_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings | Get all Custom Application Settings [**get_all_entities_custom_geo_collections**](EntitiesApi.md#get_all_entities_custom_geo_collections) | **GET** /api/v1/entities/customGeoCollections | Get all Custom Geo Collections @@ -124,6 +133,9 @@ Method | HTTP request | Description [**get_all_entities_org_memory_items**](EntitiesApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities [**get_all_entities_organization_settings**](EntitiesApi.md#get_all_entities_organization_settings) | **GET** /api/v1/entities/organizationSettings | Get Organization Setting entities [**get_all_entities_parameters**](EntitiesApi.md#get_all_entities_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters | Get all Parameters +[**get_all_entities_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 +[**get_all_entities_reports**](EntitiesApi.md#get_all_entities_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports | Get all Reports [**get_all_entities_themes**](EntitiesApi.md#get_all_entities_themes) | **GET** /api/v1/entities/themes | Get all Theming entities [**get_all_entities_user_data_filters**](EntitiesApi.md#get_all_entities_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters | Get all User Data Filters [**get_all_entities_user_groups**](EntitiesApi.md#get_all_entities_user_groups) | **GET** /api/v1/entities/userGroups | Get UserGroup entities @@ -149,6 +161,7 @@ Method | HTTP request | Description [**get_entity_attributes**](EntitiesApi.md#get_entity_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Get an Attribute [**get_entity_automations**](EntitiesApi.md#get_entity_automations) | **GET** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Get an Automation [**get_entity_color_palettes**](EntitiesApi.md#get_entity_color_palettes) | **GET** /api/v1/entities/colorPalettes/{id} | Get Color Pallette +[**get_entity_computed_attributes**](EntitiesApi.md#get_entity_computed_attributes) | **GET** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Get a Computed Attribute [**get_entity_cookie_security_configurations**](EntitiesApi.md#get_entity_cookie_security_configurations) | **GET** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Get CookieSecurityConfiguration [**get_entity_csp_directives**](EntitiesApi.md#get_entity_csp_directives) | **GET** /api/v1/entities/cspDirectives/{id} | Get CSP Directives [**get_entity_custom_application_settings**](EntitiesApi.md#get_entity_custom_application_settings) | **GET** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Get a Custom Application Setting @@ -179,6 +192,9 @@ Method | HTTP request | Description [**get_entity_organization_settings**](EntitiesApi.md#get_entity_organization_settings) | **GET** /api/v1/entities/organizationSettings/{id} | Get Organization Setting entity [**get_entity_organizations**](EntitiesApi.md#get_entity_organizations) | **GET** /api/v1/entities/admin/organizations/{id} | Get Organizations [**get_entity_parameters**](EntitiesApi.md#get_entity_parameters) | **GET** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Get a Parameter +[**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 +[**get_entity_reports**](EntitiesApi.md#get_entity_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Get a Report [**get_entity_themes**](EntitiesApi.md#get_entity_themes) | **GET** /api/v1/entities/themes/{id} | Get Theming [**get_entity_user_data_filters**](EntitiesApi.md#get_entity_user_data_filters) | **GET** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Get a User Data Filter [**get_entity_user_groups**](EntitiesApi.md#get_entity_user_groups) | **GET** /api/v1/entities/userGroups/{id} | Get UserGroup entity @@ -201,6 +217,7 @@ Method | HTTP request | Description [**patch_entity_attributes**](EntitiesApi.md#patch_entity_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId} | Patch an Attribute (beta) [**patch_entity_automations**](EntitiesApi.md#patch_entity_automations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Patch an Automation [**patch_entity_color_palettes**](EntitiesApi.md#patch_entity_color_palettes) | **PATCH** /api/v1/entities/colorPalettes/{id} | Patch Color Pallette +[**patch_entity_computed_attributes**](EntitiesApi.md#patch_entity_computed_attributes) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Patch a Computed Attribute [**patch_entity_cookie_security_configurations**](EntitiesApi.md#patch_entity_cookie_security_configurations) | **PATCH** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Patch CookieSecurityConfiguration [**patch_entity_csp_directives**](EntitiesApi.md#patch_entity_csp_directives) | **PATCH** /api/v1/entities/cspDirectives/{id} | Patch CSP Directives [**patch_entity_custom_application_settings**](EntitiesApi.md#patch_entity_custom_application_settings) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Patch a Custom Application Setting @@ -225,6 +242,9 @@ Method | HTTP request | Description [**patch_entity_organization_settings**](EntitiesApi.md#patch_entity_organization_settings) | **PATCH** /api/v1/entities/organizationSettings/{id} | Patch Organization Setting entity [**patch_entity_organizations**](EntitiesApi.md#patch_entity_organizations) | **PATCH** /api/v1/entities/admin/organizations/{id} | Patch Organization [**patch_entity_parameters**](EntitiesApi.md#patch_entity_parameters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Patch a Parameter +[**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 +[**patch_entity_reports**](EntitiesApi.md#patch_entity_reports) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Patch a Report [**patch_entity_themes**](EntitiesApi.md#patch_entity_themes) | **PATCH** /api/v1/entities/themes/{id} | Patch Theming [**patch_entity_user_data_filters**](EntitiesApi.md#patch_entity_user_data_filters) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Patch a User Data Filter [**patch_entity_user_groups**](EntitiesApi.md#patch_entity_user_groups) | **PATCH** /api/v1/entities/userGroups/{id} | Patch UserGroup entity @@ -243,6 +263,7 @@ Method | HTTP request | Description [**search_entities_attributes**](EntitiesApi.md#search_entities_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/attributes/search | The search endpoint (beta) [**search_entities_automation_results**](EntitiesApi.md#search_entities_automation_results) | **POST** /api/v1/entities/workspaces/{workspaceId}/automationResults/search | The search endpoint (beta) [**search_entities_automations**](EntitiesApi.md#search_entities_automations) | **POST** /api/v1/entities/workspaces/{workspaceId}/automations/search | The search endpoint (beta) +[**search_entities_computed_attributes**](EntitiesApi.md#search_entities_computed_attributes) | **POST** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/search | The search endpoint (beta) [**search_entities_custom_application_settings**](EntitiesApi.md#search_entities_custom_application_settings) | **POST** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search | The search endpoint (beta) [**search_entities_dashboard_plugins**](EntitiesApi.md#search_entities_dashboard_plugins) | **POST** /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search | The search endpoint (beta) [**search_entities_datasets**](EntitiesApi.md#search_entities_datasets) | **POST** /api/v1/entities/workspaces/{workspaceId}/datasets/search | The search endpoint (beta) @@ -266,6 +287,7 @@ Method | HTTP request | Description [**update_entity_attribute_hierarchies**](EntitiesApi.md#update_entity_attribute_hierarchies) | **PUT** /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId} | Put an Attribute Hierarchy [**update_entity_automations**](EntitiesApi.md#update_entity_automations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/automations/{objectId} | Put an Automation [**update_entity_color_palettes**](EntitiesApi.md#update_entity_color_palettes) | **PUT** /api/v1/entities/colorPalettes/{id} | Put Color Pallette +[**update_entity_computed_attributes**](EntitiesApi.md#update_entity_computed_attributes) | **PUT** /api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId} | Put a Computed Attribute [**update_entity_cookie_security_configurations**](EntitiesApi.md#update_entity_cookie_security_configurations) | **PUT** /api/v1/entities/admin/cookieSecurityConfigurations/{id} | Put CookieSecurityConfiguration [**update_entity_csp_directives**](EntitiesApi.md#update_entity_csp_directives) | **PUT** /api/v1/entities/cspDirectives/{id} | Put CSP Directives [**update_entity_custom_application_settings**](EntitiesApi.md#update_entity_custom_application_settings) | **PUT** /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId} | Put a Custom Application Setting @@ -289,6 +311,9 @@ Method | HTTP request | Description [**update_entity_organization_settings**](EntitiesApi.md#update_entity_organization_settings) | **PUT** /api/v1/entities/organizationSettings/{id} | Put Organization Setting entity [**update_entity_organizations**](EntitiesApi.md#update_entity_organizations) | **PUT** /api/v1/entities/admin/organizations/{id} | Put Organization [**update_entity_parameters**](EntitiesApi.md#update_entity_parameters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/parameters/{objectId} | Put a Parameter +[**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 +[**update_entity_reports**](EntitiesApi.md#update_entity_reports) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Put a Report [**update_entity_themes**](EntitiesApi.md#update_entity_themes) | **PUT** /api/v1/entities/themes/{id} | Put Theming [**update_entity_user_data_filters**](EntitiesApi.md#update_entity_user_data_filters) | **PUT** /api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId} | Put a User Data Filter [**update_entity_user_groups**](EntitiesApi.md#update_entity_user_groups) | **PUT** /api/v1/entities/userGroups/{id} | Put UserGroup entity @@ -403,6 +428,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -518,7 +551,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAnalyticalDashboardPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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,origin,accessInfo,all", @@ -811,6 +844,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -977,6 +1015,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -1096,7 +1155,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiAutomationInDocument | include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -1219,6 +1278,115 @@ 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_computed_attributes** +> JsonApiComputedAttributeOutDocument create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document) + +Post Computed Attributes + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument +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_computed_attribute_post_optional_id_document = JsonApiComputedAttributePostOptionalIdDocument( + data=JsonApiComputedAttributePostOptionalId( + attributes=JsonApiComputedAttributeInAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributePostOptionalIdDocument | + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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,origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Computed Attributes + api_response = api_instance.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Computed Attributes + api_response = api_instance.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_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_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_computed_attribute_post_optional_id_document** | [**JsonApiComputedAttributePostOptionalIdDocument**](JsonApiComputedAttributePostOptionalIdDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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 | @@ -1685,6 +1853,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -2048,7 +2217,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiFilterContextPostOptionalIdDocument | include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -2820,7 +2989,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricPostOptionalId( attributes=JsonApiMetricInAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -2838,10 +3022,10 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiMetricPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -3245,10 +3429,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_themes** -> JsonApiThemeOutDocument create_entity_themes(json_api_theme_in_document) +# **create_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document) -Post Theming +Post Report Page Layout ### Example @@ -3257,8 +3441,8 @@ Post Theming import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument 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. @@ -3271,24 +3455,45 @@ 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) - json_api_theme_in_document = JsonApiThemeInDocument( - data=JsonApiThemeIn( - attributes=JsonApiColorPaletteInAttributes( + workspace_id = "workspaceId_example" # str | + json_api_report_page_layout_post_optional_id_document = JsonApiReportPageLayoutPostOptionalIdDocument( + data=JsonApiReportPageLayoutPostOptionalId( + attributes=JsonApiReportPageLayoutInAttributes( + are_relations_valid=True, content={}, - name="name_example", + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", ), id="id1", - type="theme", + type="reportPageLayout", ), - ) # JsonApiThemeInDocument | + ) # JsonApiReportPageLayoutPostOptionalIdDocument | + 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 Theming - api_response = api_instance.create_entity_themes(json_api_theme_in_document) + # Post Report Page Layout + api_response = api_instance.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_themes: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Report Page Layout + api_response = api_instance.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_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_report_page_layouts: %s\n" % e) ``` @@ -3296,11 +3501,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | + **workspace_id** | **str**| | + **json_api_report_page_layout_post_optional_id_document** | [**JsonApiReportPageLayoutPostOptionalIdDocument**](JsonApiReportPageLayoutPostOptionalIdDocument.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 -[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -3320,10 +3528,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_user_data_filters** -> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) +# **create_entity_report_templates** +> JsonApiReportTemplateOutDocument create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document) -Post User Data Filters +Post Report Template ### Example @@ -3332,8 +3540,8 @@ Post User Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument -from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -3347,31 +3555,23 @@ 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_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( - data=JsonApiUserDataFilterPostOptionalId( - attributes=JsonApiUserDataFilterInAttributes( + json_api_report_template_post_optional_id_document = JsonApiReportTemplatePostOptionalIdDocument( + data=JsonApiReportTemplatePostOptionalId( + attributes=JsonApiReportTemplateInAttributes( are_relations_valid=True, + content={}, description="description_example", - maql="maql_example", tags=[ "tags_example", ], title="title_example", ), id="id1", - relationships=JsonApiUserDataFilterInRelationships( - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), - ), - user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( - data=JsonApiUserGroupToOneLinkage(None), - ), - ), - type="userDataFilter", + type="reportTemplate", ), - ) # JsonApiUserDataFilterPostOptionalIdDocument | + ) # JsonApiReportTemplatePostOptionalIdDocument | include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "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", @@ -3379,20 +3579,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) + # Post Report Template + api_response = api_instance.create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post User Data Filters - api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, include=include, meta_include=meta_include) + # Post Report Template + api_response = api_instance.create_entity_report_templates(workspace_id, json_api_report_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_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_report_templates: %s\n" % e) ``` @@ -3401,13 +3601,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.md)| | + **json_api_report_template_post_optional_id_document** | [**JsonApiReportTemplatePostOptionalIdDocument**](JsonApiReportTemplatePostOptionalIdDocument.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 -[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -3427,12 +3627,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_user_groups** -> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document) - -Post User Group entities +# **create_entity_reports** +> JsonApiReportOutDocument create_entity_reports(workspace_id, json_api_report_post_optional_id_document) -User Group - creates tree-like structure for categorizing users +Post Report ### Example @@ -3441,8 +3639,8 @@ User Group - creates tree-like structure for categorizing users import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument 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. @@ -3455,45 +3653,48 @@ 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) - json_api_user_group_in_document = JsonApiUserGroupInDocument( - data=JsonApiUserGroupIn( - attributes=JsonApiUserGroupInAttributes( - name="name_example", + workspace_id = "workspaceId_example" # str | + json_api_report_post_optional_id_document = JsonApiReportPostOptionalIdDocument( + data=JsonApiReportPostOptionalId( + attributes=JsonApiReportInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", + ], + title="title_example", + variable_values=None, ), id="id1", - relationships=JsonApiUserGroupInRelationships( - parents=JsonApiAgentInRelationshipsUserGroups( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="userGroup", + type="report", ), - ) # JsonApiUserGroupInDocument | + ) # JsonApiReportPostOptionalIdDocument | include = [ - "parents", + "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 User Group entities - api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document) + # Post Report + api_response = api_instance.create_entity_reports(workspace_id, json_api_report_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_user_groups: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post User Group entities - api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document, include=include) + # Post Report + api_response = api_instance.create_entity_reports(workspace_id, json_api_report_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_user_groups: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_reports: %s\n" % e) ``` @@ -3501,12 +3702,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.md)| | + **workspace_id** | **str**| | + **json_api_report_post_optional_id_document** | [**JsonApiReportPostOptionalIdDocument**](JsonApiReportPostOptionalIdDocument.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 -[**JsonApiUserGroupOutDocument**](JsonApiUserGroupOutDocument.md) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization @@ -3526,10 +3729,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_user_settings** -> JsonApiUserSettingOutDocument create_entity_user_settings(user_id, json_api_user_setting_in_document) +# **create_entity_themes** +> JsonApiThemeOutDocument create_entity_themes(json_api_theme_in_document) -Post new user settings for the user +Post Theming ### Example @@ -3538,8 +3741,8 @@ Post new user settings for the user import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument -from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument +from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument +from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -3552,25 +3755,24 @@ 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 | - json_api_user_setting_in_document = JsonApiUserSettingInDocument( - data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + json_api_theme_in_document = JsonApiThemeInDocument( + data=JsonApiThemeIn( + attributes=JsonApiColorPaletteInAttributes( content={}, - type="TIMEZONE", + name="name_example", ), id="id1", - type="userSetting", + type="theme", ), - ) # JsonApiUserSettingInDocument | + ) # JsonApiThemeInDocument | # example passing only required values which don't have defaults set try: - # Post new user settings for the user - api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) + # Post Theming + api_response = api_instance.create_entity_themes(json_api_theme_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_user_settings: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_themes: %s\n" % e) ``` @@ -3578,12 +3780,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | + **json_api_theme_in_document** | [**JsonApiThemeInDocument**](JsonApiThemeInDocument.md)| | ### Return type -[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) +[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) ### Authorization @@ -3603,12 +3804,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_users** -> JsonApiUserOutDocument create_entity_users(json_api_user_in_document) - -Post User entities +# **create_entity_user_data_filters** +> JsonApiUserDataFilterOutDocument create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) -User - represents entity interacting with platform +Post User Data Filters ### Example @@ -3617,8 +3816,8 @@ User - represents entity interacting with platform import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.model.json_api_user_data_filter_post_optional_id_document import JsonApiUserDataFilterPostOptionalIdDocument 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. @@ -3631,49 +3830,53 @@ 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) - json_api_user_in_document = JsonApiUserInDocument( - data=JsonApiUserIn( - attributes=JsonApiUserInAttributes( - authentication_id="authentication_id_example", - email="email_example", - firstname="firstname_example", - lastname="lastname_example", - system_account=False, + workspace_id = "workspaceId_example" # str | + json_api_user_data_filter_post_optional_id_document = JsonApiUserDataFilterPostOptionalIdDocument( + data=JsonApiUserDataFilterPostOptionalId( + attributes=JsonApiUserDataFilterInAttributes( + are_relations_valid=True, + description="description_example", + maql="maql_example", + tags=[ + "tags_example", + ], + title="title_example", ), id="id1", - relationships=JsonApiAgentInRelationships( - user_groups=JsonApiAgentInRelationshipsUserGroups( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), + relationships=JsonApiUserDataFilterInRelationships( + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), + ), + user_group=JsonApiOrganizationOutRelationshipsBootstrapUserGroup( + data=JsonApiUserGroupToOneLinkage(None), ), ), - type="user", + type="userDataFilter", ), - ) # JsonApiUserInDocument | + ) # JsonApiUserDataFilterPostOptionalIdDocument | include = [ - "userGroups", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 User entities - api_response = api_instance.create_entity_users(json_api_user_in_document) + # Post User Data Filters + api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_users: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_user_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post User entities - api_response = api_instance.create_entity_users(json_api_user_in_document, include=include) + # Post User Data Filters + api_response = api_instance.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_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_users: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_user_data_filters: %s\n" % e) ``` @@ -3681,12 +3884,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.md)| | + **workspace_id** | **str**| | + **json_api_user_data_filter_post_optional_id_document** | [**JsonApiUserDataFilterPostOptionalIdDocument**](JsonApiUserDataFilterPostOptionalIdDocument.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 -[**JsonApiUserOutDocument**](JsonApiUserOutDocument.md) +[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) ### Authorization @@ -3706,10 +3911,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) -# **create_entity_visualization_objects** -> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) +# **create_entity_user_groups** +> JsonApiUserGroupOutDocument create_entity_user_groups(json_api_user_group_in_document) -Post Visualization Objects +Post User Group entities + +User Group - creates tree-like structure for categorizing users ### Example @@ -3718,8 +3925,8 @@ Post Visualization Objects import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument -from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument +from gooddata_api_client.model.json_api_user_group_in_document import JsonApiUserGroupInDocument +from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument 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. @@ -3732,46 +3939,45 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( - data=JsonApiVisualizationObjectPostOptionalId( - attributes=JsonApiVisualizationObjectInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - is_hidden=True, - tags=[ - "tags_example", - ], - title="title_example", + json_api_user_group_in_document = JsonApiUserGroupInDocument( + data=JsonApiUserGroupIn( + attributes=JsonApiUserGroupInAttributes( + name="name_example", ), id="id1", - type="visualizationObject", + relationships=JsonApiUserGroupInRelationships( + parents=JsonApiAgentInRelationshipsUserGroups( + data=JsonApiUserGroupToManyLinkage([ + JsonApiUserGroupLinkage( + id="id_example", + type="userGroup", + ), + ]), + ), + ), + type="userGroup", ), - ) # JsonApiVisualizationObjectPostOptionalIdDocument | + ) # JsonApiUserGroupInDocument | include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "parents", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) + # Post User Group entities + api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_user_groups: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Visualization Objects - api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, include=include, meta_include=meta_include) + # Post User Group entities + api_response = api_instance.create_entity_user_groups(json_api_user_group_in_document, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_user_groups: %s\n" % e) ``` @@ -3779,14 +3985,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.md)| | + **json_api_user_group_in_document** | [**JsonApiUserGroupInDocument**](JsonApiUserGroupInDocument.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 -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) +[**JsonApiUserGroupOutDocument**](JsonApiUserGroupOutDocument.md) ### Authorization @@ -3806,10 +4010,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_workspace_color_palettes** -> JsonApiWorkspaceColorPaletteOutDocument create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) +# **create_entity_user_settings** +> JsonApiUserSettingOutDocument create_entity_user_settings(user_id, json_api_user_setting_in_document) -Post Workspace Color Palette +Post new user settings for the user ### Example @@ -3818,8 +4022,8 @@ Post Workspace Color Palette import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument -from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument +from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument 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. @@ -3832,37 +4036,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( - data=JsonApiWorkspaceColorPaletteIn( - attributes=JsonApiColorPaletteInAttributes( + user_id = "userId_example" # str | + json_api_user_setting_in_document = JsonApiUserSettingInDocument( + data=JsonApiUserSettingIn( + attributes=JsonApiUserSettingInAttributes( content={}, - name="name_example", + type="TIMEZONE", ), id="id1", - type="workspaceColorPalette", + type="userSetting", ), - ) # JsonApiWorkspaceColorPaletteInDocument | - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Post Workspace Color Palette - api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_color_palettes: %s\n" % e) + ) # JsonApiUserSettingInDocument | # example passing only required values which don't have defaults set - # and optional values try: - # Post Workspace Color Palette - api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, meta_include=meta_include) + # Post new user settings for the user + api_response = api_instance.create_entity_user_settings(user_id, json_api_user_setting_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_user_settings: %s\n" % e) ``` @@ -3870,13 +4062,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | - **meta_include** | **[str]**| Include Meta objects. | [optional] + **user_id** | **str**| | + **json_api_user_setting_in_document** | [**JsonApiUserSettingInDocument**](JsonApiUserSettingInDocument.md)| | ### Return type -[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) +[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) ### Authorization @@ -3896,10 +4087,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) -# **create_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) +# **create_entity_users** +> JsonApiUserOutDocument create_entity_users(json_api_user_in_document) -Post Settings for Workspace Data Filters +Post User entities + +User - represents entity interacting with platform ### Example @@ -3908,8 +4101,8 @@ Post Settings for Workspace Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.model.json_api_user_in_document import JsonApiUserInDocument +from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument 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. @@ -3922,48 +4115,49 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( - data=JsonApiWorkspaceDataFilterSettingIn( - attributes=JsonApiWorkspaceDataFilterSettingInAttributes( - description="description_example", - filter_values=[ - "filter_values_example", - ], - title="title_example", + json_api_user_in_document = JsonApiUserInDocument( + data=JsonApiUserIn( + attributes=JsonApiUserInAttributes( + authentication_id="authentication_id_example", + email="email_example", + firstname="firstname_example", + lastname="lastname_example", + system_account=False, ), id="id1", - relationships=JsonApiWorkspaceDataFilterSettingInRelationships( - workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( - data=JsonApiWorkspaceDataFilterToOneLinkage(None), + relationships=JsonApiAgentInRelationships( + user_groups=JsonApiAgentInRelationshipsUserGroups( + data=JsonApiUserGroupToManyLinkage([ + JsonApiUserGroupLinkage( + id="id_example", + type="userGroup", + ), + ]), ), ), - type="workspaceDataFilterSetting", + type="user", ), - ) # JsonApiWorkspaceDataFilterSettingInDocument | + ) # JsonApiUserInDocument | include = [ - "workspaceDataFilter", + "userGroups", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) + # Post User entities + api_response = api_instance.create_entity_users(json_api_user_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_users: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Settings for Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) + # Post User entities + api_response = api_instance.create_entity_users(json_api_user_in_document, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_users: %s\n" % e) ``` @@ -3971,14 +4165,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.md)| | + **json_api_user_in_document** | [**JsonApiUserInDocument**](JsonApiUserInDocument.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 -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) +[**JsonApiUserOutDocument**](JsonApiUserOutDocument.md) ### Authorization @@ -3998,10 +4190,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) +# **create_entity_visualization_objects** +> JsonApiVisualizationObjectOutDocument create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) -Post Workspace Data Filters +Post Visualization Objects ### Example @@ -4010,8 +4202,8 @@ Post Workspace Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument -from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_visualization_object_post_optional_id_document import JsonApiVisualizationObjectPostOptionalIdDocument 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. @@ -4025,50 +4217,66 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( - data=JsonApiWorkspaceDataFilterIn( - attributes=JsonApiWorkspaceDataFilterInAttributes( - column_name="column_name_example", - description="description_example", - title="title_example", - ), - id="id1", - relationships=JsonApiWorkspaceDataFilterInRelationships( - filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( - data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ - JsonApiWorkspaceDataFilterSettingLinkage( - id="id_example", - type="workspaceDataFilterSetting", + json_api_visualization_object_post_optional_id_document = JsonApiVisualizationObjectPostOptionalIdDocument( + data=JsonApiVisualizationObjectPostOptionalId( + attributes=JsonApiVisualizationObjectInAttributes( + are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), ), - ]), + ], ), + content={}, + description="description_example", + is_hidden=True, + tags=[ + "tags_example", + ], + title="title_example", ), - type="workspaceDataFilter", + id="id1", + type="visualizationObject", ), - ) # JsonApiWorkspaceDataFilterInDocument | + ) # JsonApiVisualizationObjectPostOptionalIdDocument | include = [ - "filterSettings", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ - "metaInclude=origin,all", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) + # Post Visualization Objects + api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_visualization_objects: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Workspace Data Filters - api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) + # Post Visualization Objects + api_response = api_instance.create_entity_visualization_objects(workspace_id, json_api_visualization_object_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_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_visualization_objects: %s\n" % e) ``` @@ -4077,13 +4285,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.md)| | + **json_api_visualization_object_post_optional_id_document** | [**JsonApiVisualizationObjectPostOptionalIdDocument**](JsonApiVisualizationObjectPostOptionalIdDocument.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 -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) ### Authorization @@ -4103,10 +4311,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_workspace_export_templates** -> JsonApiWorkspaceExportTemplateOutDocument create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) +# **create_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) -Post Workspace Export Template +Post Workspace Color Palette ### Example @@ -4115,8 +4323,8 @@ Post Workspace Export Template import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_in_document import JsonApiWorkspaceColorPaletteInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4130,102 +4338,36 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_workspace_export_template_post_optional_id_document = JsonApiWorkspaceExportTemplatePostOptionalIdDocument( - data=JsonApiWorkspaceExportTemplatePostOptionalId( - attributes=JsonApiWorkspaceExportTemplateInAttributes( - dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), + json_api_workspace_color_palette_in_document = JsonApiWorkspaceColorPaletteInDocument( + data=JsonApiWorkspaceColorPaletteIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, name="name_example", - widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), ), id="id1", - type="workspaceExportTemplate", + type="workspaceColorPalette", ), - ) # JsonApiWorkspaceExportTemplatePostOptionalIdDocument | + ) # JsonApiWorkspaceColorPaletteInDocument | meta_include = [ "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Workspace Export Template - api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Workspace Export Template - api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, meta_include=meta_include) + # Post Workspace Color Palette + api_response = api_instance.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_color_palettes: %s\n" % e) ``` @@ -4234,12 +4376,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_workspace_export_template_post_optional_id_document** | [**JsonApiWorkspaceExportTemplatePostOptionalIdDocument**](JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md)| | + **json_api_workspace_color_palette_in_document** | [**JsonApiWorkspaceColorPaletteInDocument**](JsonApiWorkspaceColorPaletteInDocument.md)| | **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) ### Authorization @@ -4259,10 +4401,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) +# **create_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) -Post Settings for Workspaces +Post Settings for Workspace Data Filters ### Example @@ -4271,8 +4413,8 @@ Post Settings for Workspaces import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_in_document import JsonApiWorkspaceDataFilterSettingInDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4286,36 +4428,47 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( - data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( - content={}, - type="TIMEZONE", + json_api_workspace_data_filter_setting_in_document = JsonApiWorkspaceDataFilterSettingInDocument( + data=JsonApiWorkspaceDataFilterSettingIn( + attributes=JsonApiWorkspaceDataFilterSettingInAttributes( + description="description_example", + filter_values=[ + "filter_values_example", + ], + title="title_example", ), id="id1", - type="workspaceSetting", + relationships=JsonApiWorkspaceDataFilterSettingInRelationships( + workspace_data_filter=JsonApiWorkspaceDataFilterSettingInRelationshipsWorkspaceDataFilter( + data=JsonApiWorkspaceDataFilterToOneLinkage(None), + ), + ), + type="workspaceDataFilterSetting", ), - ) # JsonApiWorkspaceSettingPostOptionalIdDocument | + ) # JsonApiWorkspaceDataFilterSettingInDocument | + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + # Post Settings for Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_data_filter_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Settings for Workspaces - api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) + # Post Settings for Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_data_filter_settings: %s\n" % e) ``` @@ -4324,12 +4477,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | + **json_api_workspace_data_filter_setting_in_document** | [**JsonApiWorkspaceDataFilterSettingInDocument**](JsonApiWorkspaceDataFilterSettingInDocument.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 -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) ### Authorization @@ -4349,10 +4503,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_workspace_themes** -> JsonApiWorkspaceThemeOutDocument create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) +# **create_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) -Post Workspace Theme +Post Workspace Data Filters ### Example @@ -4361,8 +4515,8 @@ Post Workspace Theme import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument -from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_in_document import JsonApiWorkspaceDataFilterInDocument 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. @@ -4376,36 +4530,50 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( - data=JsonApiWorkspaceThemeIn( - attributes=JsonApiColorPaletteInAttributes( - content={}, - name="name_example", + json_api_workspace_data_filter_in_document = JsonApiWorkspaceDataFilterInDocument( + data=JsonApiWorkspaceDataFilterIn( + attributes=JsonApiWorkspaceDataFilterInAttributes( + column_name="column_name_example", + description="description_example", + title="title_example", ), id="id1", - type="workspaceTheme", + relationships=JsonApiWorkspaceDataFilterInRelationships( + filter_settings=JsonApiWorkspaceDataFilterInRelationshipsFilterSettings( + data=JsonApiWorkspaceDataFilterSettingToManyLinkage([ + JsonApiWorkspaceDataFilterSettingLinkage( + id="id_example", + type="workspaceDataFilterSetting", + ), + ]), + ), + ), + type="workspaceDataFilter", ), - ) # JsonApiWorkspaceThemeInDocument | + ) # JsonApiWorkspaceDataFilterInDocument | + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Workspace Theme - api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + # Post Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Workspace Theme - api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, meta_include=meta_include) + # Post Workspace Data Filters + api_response = api_instance.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_data_filters: %s\n" % e) ``` @@ -4414,12 +4582,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **json_api_workspace_data_filter_in_document** | [**JsonApiWorkspaceDataFilterInDocument**](JsonApiWorkspaceDataFilterInDocument.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 -[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) ### Authorization @@ -4439,12 +4608,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_workspaces** -> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document) - -Post Workspace entities +# **create_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) -Space of the shared interest +Post Workspace Export Template ### Example @@ -4453,8 +4620,8 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument -from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument +from gooddata_api_client.model.json_api_workspace_export_template_post_optional_id_document import JsonApiWorkspaceExportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4467,56 +4634,103 @@ 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) - json_api_workspace_in_document = JsonApiWorkspaceInDocument( - data=JsonApiWorkspaceIn( - attributes=JsonApiWorkspaceInAttributes( - cache_extra_limit=1, - data_source=JsonApiWorkspaceInAttributesDataSource( - id="snowflake.instance.1", - schema_path=[ - "subPath", - ], + workspace_id = "workspaceId_example" # str | + json_api_workspace_export_template_post_optional_id_document = JsonApiWorkspaceExportTemplatePostOptionalIdDocument( + data=JsonApiWorkspaceExportTemplatePostOptionalId( + attributes=JsonApiWorkspaceExportTemplateInAttributes( + dashboard_slides_template=JsonApiWorkspaceExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), ), - description="description_example", - early_access="early_access_example", - early_access_values=[ - "early_access_values_example", - ], name="name_example", - prefix="/6bUUGjjNSwg0_bs", - ), - id="id1", - relationships=JsonApiWorkspaceInRelationships( - parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( - data=JsonApiWorkspaceToOneLinkage(None), + widget_slides_template=JsonApiWorkspaceExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), ), ), - type="workspace", + id="id1", + type="workspaceExportTemplate", ), - ) # JsonApiWorkspaceInDocument | - include = [ - "parent", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiWorkspaceExportTemplatePostOptionalIdDocument | meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Post Workspace entities - api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document) + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Workspace entities - api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) + # Post Workspace Export Template + api_response = api_instance.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->create_entity_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_export_templates: %s\n" % e) ``` @@ -4524,13 +4738,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.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] + **workspace_id** | **str**| | + **json_api_workspace_export_template_post_optional_id_document** | [**JsonApiWorkspaceExportTemplatePostOptionalIdDocument**](JsonApiWorkspaceExportTemplatePostOptionalIdDocument.md)| | **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceOutDocument**](JsonApiWorkspaceOutDocument.md) +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) ### Authorization @@ -4550,12 +4764,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity** -> delete_entity(id) - -Delete LLM endpoint entity (Removed) +# **create_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) -Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. +Post Settings for Workspaces ### Example @@ -4564,6 +4776,8 @@ Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 4 import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_setting_post_optional_id_document import JsonApiWorkspaceSettingPostOptionalIdDocument +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4576,14 +4790,37 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "id_example" # str | + workspace_id = "workspaceId_example" # str | + json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( + data=JsonApiWorkspaceSettingPostOptionalId( + attributes=JsonApiUserSettingInAttributes( + content={}, + type="TIMEZONE", + ), + id="id1", + type="workspaceSetting", + ), + ) # JsonApiWorkspaceSettingPostOptionalIdDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Delete LLM endpoint entity (Removed) - api_instance.delete_entity(id) + # Post Settings for Workspaces + api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Settings for Workspaces + api_response = api_instance.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_settings: %s\n" % e) ``` @@ -4591,11 +4828,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **json_api_workspace_setting_post_optional_id_document** | [**JsonApiWorkspaceSettingPostOptionalIdDocument**](JsonApiWorkspaceSettingPostOptionalIdDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) ### Authorization @@ -4603,22 +4842,22 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **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 | |-------------|-------------|------------------| -**410** | Gone | - | +**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_agents** -> delete_entity_agents(id) +# **create_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) -Delete Agent entity +Post Workspace Theme ### Example @@ -4627,6 +4866,8 @@ Delete Agent entity import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_workspace_theme_in_document import JsonApiWorkspaceThemeInDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -4639,14 +4880,37 @@ 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 | + json_api_workspace_theme_in_document = JsonApiWorkspaceThemeInDocument( + data=JsonApiWorkspaceThemeIn( + attributes=JsonApiColorPaletteInAttributes( + content={}, + name="name_example", + ), + id="id1", + type="workspaceTheme", + ), + ) # JsonApiWorkspaceThemeInDocument | + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Delete Agent entity - api_instance.delete_entity_agents(id) + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_agents: %s\n" % e) + print("Exception when calling EntitiesApi->create_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace Theme + api_response = api_instance.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspace_themes: %s\n" % e) ``` @@ -4654,11 +4918,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **json_api_workspace_theme_in_document** | [**JsonApiWorkspaceThemeInDocument**](JsonApiWorkspaceThemeInDocument.md)| | + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) ### Authorization @@ -4666,22 +4932,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **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 | |-------------|-------------|------------------| -**204** | Successfully deleted | - | +**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_analytical_dashboards** -> delete_entity_analytical_dashboards(workspace_id, object_id) +# **create_entity_workspaces** +> JsonApiWorkspaceOutDocument create_entity_workspaces(json_api_workspace_in_document) -Delete a Dashboard +Post Workspace entities + +Space of the shared interest ### Example @@ -4690,6 +4958,8 @@ Delete a Dashboard import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.model.json_api_workspace_in_document import JsonApiWorkspaceInDocument 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. @@ -4702,28 +4972,70 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - - # example passing only required values which don't have defaults set - try: - # Delete a Dashboard - api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_analytical_dashboards: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes + json_api_workspace_in_document = JsonApiWorkspaceInDocument( + data=JsonApiWorkspaceIn( + attributes=JsonApiWorkspaceInAttributes( + cache_extra_limit=1, + data_source=JsonApiWorkspaceInAttributesDataSource( + id="snowflake.instance.1", + schema_path=[ + "subPath", + ], + ), + description="description_example", + early_access="early_access_example", + early_access_values=[ + "early_access_values_example", + ], + name="name_example", + prefix="/6bUUGjjNSwg0_bs", + ), + id="id1", + relationships=JsonApiWorkspaceInRelationships( + parent=JsonApiWorkspaceAutomationOutRelationshipsWorkspace( + data=JsonApiWorkspaceToOneLinkage(None), + ), + ), + type="workspace", + ), + ) # JsonApiWorkspaceInDocument | + include = [ + "parent", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Workspace entities + api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Workspace entities + api_response = api_instance.create_entity_workspaces(json_api_workspace_in_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->create_entity_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **json_api_workspace_in_document** | [**JsonApiWorkspaceInDocument**](JsonApiWorkspaceInDocument.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 -void (empty response body) +[**JsonApiWorkspaceOutDocument**](JsonApiWorkspaceOutDocument.md) ### Authorization @@ -4731,22 +5043,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined + - **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 | |-------------|-------------|------------------| -**204** | Successfully deleted | - | +**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_api_tokens** -> delete_entity_api_tokens(user_id, id) +# **delete_entity** +> delete_entity(id) -Delete an API Token for a user +Delete LLM endpoint entity (Removed) + +Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. ### Example @@ -4767,15 +5081,14 @@ 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 | + id = "id_example" # str | # example passing only required values which don't have defaults set try: - # Delete an API Token for a user - api_instance.delete_entity_api_tokens(user_id, id) + # Delete LLM endpoint entity (Removed) + api_instance.delete_entity(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_api_tokens: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity: %s\n" % e) ``` @@ -4783,7 +5096,6 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | **id** | **str**| | ### Return type @@ -4804,14 +5116,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**204** | Successfully deleted | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_attribute_hierarchies** -> delete_entity_attribute_hierarchies(workspace_id, object_id) +# **delete_entity_agents** +> delete_entity_agents(id) -Delete an Attribute Hierarchy +Delete Agent entity ### Example @@ -4832,15 +5144,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete an Attribute Hierarchy - api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) + # Delete Agent entity + api_instance.delete_entity_agents(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_agents: %s\n" % e) ``` @@ -4848,8 +5159,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -4873,10 +5183,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_automations** -> delete_entity_automations(workspace_id, object_id) +# **delete_entity_analytical_dashboards** +> delete_entity_analytical_dashboards(workspace_id, object_id) -Delete an Automation +Delete a Dashboard ### Example @@ -4902,10 +5212,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete an Automation - api_instance.delete_entity_automations(workspace_id, object_id) + # Delete a Dashboard + api_instance.delete_entity_analytical_dashboards(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_automations: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_analytical_dashboards: %s\n" % e) ``` @@ -4938,10 +5248,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_color_palettes** -> delete_entity_color_palettes(id) +# **delete_entity_api_tokens** +> delete_entity_api_tokens(user_id, id) -Delete a Color Pallette +Delete an API Token for a user ### Example @@ -4962,14 +5272,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) + user_id = "userId_example" # str | id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Color Pallette - api_instance.delete_entity_color_palettes(id) + # Delete an API Token for a user + api_instance.delete_entity_api_tokens(user_id, id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_api_tokens: %s\n" % e) ``` @@ -4977,6 +5288,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | **id** | **str**| | ### Return type @@ -5001,12 +5313,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_csp_directives** -> delete_entity_csp_directives(id) - -Delete CSP Directives +# **delete_entity_attribute_hierarchies** +> delete_entity_attribute_hierarchies(workspace_id, object_id) - Context Security Police Directive +Delete an Attribute Hierarchy ### Example @@ -5027,14 +5337,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 CSP Directives - api_instance.delete_entity_csp_directives(id) + # Delete an Attribute Hierarchy + api_instance.delete_entity_attribute_hierarchies(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_csp_directives: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_attribute_hierarchies: %s\n" % e) ``` @@ -5042,7 +5353,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -5066,10 +5378,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_custom_application_settings** -> delete_entity_custom_application_settings(workspace_id, object_id) +# **delete_entity_automations** +> delete_entity_automations(workspace_id, object_id) -Delete a Custom Application Setting +Delete an Automation ### Example @@ -5095,10 +5407,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Custom Application Setting - api_instance.delete_entity_custom_application_settings(workspace_id, object_id) + # Delete an Automation + api_instance.delete_entity_automations(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_custom_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_automations: %s\n" % e) ``` @@ -5131,10 +5443,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_custom_geo_collections** -> delete_entity_custom_geo_collections(id) +# **delete_entity_color_palettes** +> delete_entity_color_palettes(id) -Delete Custom Geo Collection +Delete a Color Pallette ### Example @@ -5159,10 +5471,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete Custom Geo Collection - api_instance.delete_entity_custom_geo_collections(id) + # Delete a Color Pallette + api_instance.delete_entity_color_palettes(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_custom_geo_collections: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_color_palettes: %s\n" % e) ``` @@ -5194,10 +5506,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_custom_user_application_settings** -> delete_entity_custom_user_application_settings(user_id, id) +# **delete_entity_computed_attributes** +> delete_entity_computed_attributes(workspace_id, object_id) -Delete a custom application setting for a user +Delete a Computed Attribute ### Example @@ -5218,15 +5530,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) - user_id = "userId_example" # str | - 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 a custom application setting for a user - api_instance.delete_entity_custom_user_application_settings(user_id, id) + # Delete a Computed Attribute + api_instance.delete_entity_computed_attributes(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_computed_attributes: %s\n" % e) ``` @@ -5234,8 +5546,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -5259,10 +5571,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) -# **delete_entity_dashboard_plugins** -> delete_entity_dashboard_plugins(workspace_id, object_id) +# **delete_entity_csp_directives** +> delete_entity_csp_directives(id) -Delete a Plugin +Delete CSP Directives + + Context Security Police Directive ### Example @@ -5283,15 +5597,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Plugin - api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) + # Delete CSP Directives + api_instance.delete_entity_csp_directives(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_csp_directives: %s\n" % e) ``` @@ -5299,8 +5612,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -5324,12 +5636,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_data_sources** -> delete_entity_data_sources(id) - -Delete Data Source entity +# **delete_entity_custom_application_settings** +> delete_entity_custom_application_settings(workspace_id, object_id) -Data Source - represents data source for the workspace +Delete a Custom Application Setting ### Example @@ -5350,14 +5660,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 Data Source entity - api_instance.delete_entity_data_sources(id) + # Delete a Custom Application Setting + api_instance.delete_entity_custom_application_settings(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_custom_application_settings: %s\n" % e) ``` @@ -5365,7 +5676,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -5389,10 +5701,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_export_definitions** -> delete_entity_export_definitions(workspace_id, object_id) +# **delete_entity_custom_geo_collections** +> delete_entity_custom_geo_collections(id) -Delete an Export Definition +Delete Custom Geo Collection ### Example @@ -5413,15 +5725,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete an Export Definition - api_instance.delete_entity_export_definitions(workspace_id, object_id) + # Delete Custom Geo Collection + api_instance.delete_entity_custom_geo_collections(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_custom_geo_collections: %s\n" % e) ``` @@ -5429,8 +5740,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -5454,10 +5764,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_export_templates** -> delete_entity_export_templates(id) +# **delete_entity_custom_user_application_settings** +> delete_entity_custom_user_application_settings(user_id, id) -Delete Export Template entity +Delete a custom application setting for a user ### Example @@ -5478,14 +5788,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) + user_id = "userId_example" # str | id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete Export Template entity - api_instance.delete_entity_export_templates(id) + # Delete a custom application setting for a user + api_instance.delete_entity_custom_user_application_settings(user_id, id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_custom_user_application_settings: %s\n" % e) ``` @@ -5493,6 +5804,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | **id** | **str**| | ### Return type @@ -5517,10 +5829,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_filter_contexts** -> delete_entity_filter_contexts(workspace_id, object_id) +# **delete_entity_dashboard_plugins** +> delete_entity_dashboard_plugins(workspace_id, object_id) -Delete a Filter Context +Delete a Plugin ### Example @@ -5546,10 +5858,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Filter Context - api_instance.delete_entity_filter_contexts(workspace_id, object_id) + # Delete a Plugin + api_instance.delete_entity_dashboard_plugins(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_dashboard_plugins: %s\n" % e) ``` @@ -5582,10 +5894,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) -# **delete_entity_filter_views** -> delete_entity_filter_views(workspace_id, object_id) +# **delete_entity_data_sources** +> delete_entity_data_sources(id) -Delete Filter view +Delete Data Source entity + +Data Source - represents data source for the workspace ### Example @@ -5606,15 +5920,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete Filter view - api_instance.delete_entity_filter_views(workspace_id, object_id) + # Delete Data Source entity + api_instance.delete_entity_data_sources(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_filter_views: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_data_sources: %s\n" % e) ``` @@ -5622,8 +5935,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -5647,10 +5959,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_identity_providers** -> delete_entity_identity_providers(id) +# **delete_entity_export_definitions** +> delete_entity_export_definitions(workspace_id, object_id) -Delete Identity Provider +Delete an Export Definition ### Example @@ -5671,14 +5983,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 Identity Provider - api_instance.delete_entity_identity_providers(id) + # Delete an Export Definition + api_instance.delete_entity_export_definitions(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_export_definitions: %s\n" % e) ``` @@ -5686,7 +5999,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -5710,10 +6024,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_ip_allowlist_policies** -> delete_entity_ip_allowlist_policies(id) +# **delete_entity_export_templates** +> delete_entity_export_templates(id) -Delete IpAllowlistPolicy entity +Delete Export Template entity ### Example @@ -5738,10 +6052,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete IpAllowlistPolicy entity - api_instance.delete_entity_ip_allowlist_policies(id) + # Delete Export Template entity + api_instance.delete_entity_export_templates(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_ip_allowlist_policies: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_export_templates: %s\n" % e) ``` @@ -5773,12 +6087,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_jwks** -> delete_entity_jwks(id) - -Delete Jwk +# **delete_entity_filter_contexts** +> delete_entity_filter_contexts(workspace_id, object_id) -Deletes JSON web key - used to verify JSON web tokens (Jwts) +Delete a Filter Context ### Example @@ -5799,14 +6111,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 Jwk - api_instance.delete_entity_jwks(id) + # Delete a Filter Context + api_instance.delete_entity_filter_contexts(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_filter_contexts: %s\n" % e) ``` @@ -5814,7 +6127,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -5838,10 +6152,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_knowledge_recommendations** -> delete_entity_knowledge_recommendations(workspace_id, object_id) +# **delete_entity_filter_views** +> delete_entity_filter_views(workspace_id, object_id) -Delete a Knowledge Recommendation +Delete Filter view ### Example @@ -5867,10 +6181,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Knowledge Recommendation - api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id) + # Delete Filter view + api_instance.delete_entity_filter_views(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_filter_views: %s\n" % e) ``` @@ -5903,10 +6217,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_llm_providers** -> delete_entity_llm_providers(id) +# **delete_entity_identity_providers** +> delete_entity_identity_providers(id) -Delete LLM Provider entity +Delete Identity Provider ### Example @@ -5931,10 +6245,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete LLM Provider entity - api_instance.delete_entity_llm_providers(id) + # Delete Identity Provider + api_instance.delete_entity_identity_providers(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_llm_providers: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_identity_providers: %s\n" % e) ``` @@ -5966,10 +6280,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_memory_items** -> delete_entity_memory_items(workspace_id, object_id) +# **delete_entity_ip_allowlist_policies** +> delete_entity_ip_allowlist_policies(id) -Delete a Memory Item +Delete IpAllowlistPolicy entity ### Example @@ -5990,15 +6304,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Memory Item - api_instance.delete_entity_memory_items(workspace_id, object_id) + # Delete IpAllowlistPolicy entity + api_instance.delete_entity_ip_allowlist_policies(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_ip_allowlist_policies: %s\n" % e) ``` @@ -6006,8 +6319,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -6031,10 +6343,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) -# **delete_entity_metrics** -> delete_entity_metrics(workspace_id, object_id) +# **delete_entity_jwks** +> delete_entity_jwks(id) -Delete a Metric +Delete Jwk + +Deletes JSON web key - used to verify JSON web tokens (Jwts) ### Example @@ -6055,15 +6369,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Metric - api_instance.delete_entity_metrics(workspace_id, object_id) + # Delete Jwk + api_instance.delete_entity_jwks(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_metrics: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_jwks: %s\n" % e) ``` @@ -6071,8 +6384,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -6096,10 +6408,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_notification_channels** -> delete_entity_notification_channels(id) +# **delete_entity_knowledge_recommendations** +> delete_entity_knowledge_recommendations(workspace_id, object_id) -Delete Notification Channel entity +Delete a Knowledge Recommendation ### Example @@ -6120,14 +6432,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 Notification Channel entity - api_instance.delete_entity_notification_channels(id) + # Delete a Knowledge Recommendation + api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_notification_channels: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_knowledge_recommendations: %s\n" % e) ``` @@ -6135,7 +6448,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -6159,10 +6473,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_org_memory_items** -> delete_entity_org_memory_items(id) +# **delete_entity_llm_providers** +> delete_entity_llm_providers(id) -Delete an organization Memory Item entity +Delete LLM Provider entity ### Example @@ -6187,10 +6501,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete an organization Memory Item entity - api_instance.delete_entity_org_memory_items(id) + # Delete LLM Provider entity + api_instance.delete_entity_llm_providers(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_org_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_llm_providers: %s\n" % e) ``` @@ -6222,10 +6536,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_organization_settings** -> delete_entity_organization_settings(id) +# **delete_entity_memory_items** +> delete_entity_memory_items(workspace_id, object_id) -Delete Organization Setting entity +Delete a Memory Item ### Example @@ -6246,14 +6560,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 Memory Item + api_instance.delete_entity_memory_items(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_memory_items: %s\n" % e) ``` @@ -6261,7 +6576,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -6285,10 +6601,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_parameters** -> delete_entity_parameters(workspace_id, object_id) +# **delete_entity_metrics** +> delete_entity_metrics(workspace_id, object_id) -Delete a Parameter +Delete a Metric ### Example @@ -6314,10 +6630,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Parameter - api_instance.delete_entity_parameters(workspace_id, object_id) + # Delete a Metric + api_instance.delete_entity_metrics(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_metrics: %s\n" % e) ``` @@ -6350,10 +6666,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_themes** -> delete_entity_themes(id) +# **delete_entity_notification_channels** +> delete_entity_notification_channels(id) -Delete Theming +Delete Notification Channel entity ### Example @@ -6378,10 +6694,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete Theming - api_instance.delete_entity_themes(id) + # Delete Notification Channel entity + api_instance.delete_entity_notification_channels(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_themes: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_notification_channels: %s\n" % e) ``` @@ -6413,10 +6729,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_user_data_filters** -> delete_entity_user_data_filters(workspace_id, object_id) +# **delete_entity_org_memory_items** +> delete_entity_org_memory_items(id) -Delete a User Data Filter +Delete an organization Memory Item entity ### Example @@ -6437,15 +6753,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a User Data Filter - api_instance.delete_entity_user_data_filters(workspace_id, object_id) + # Delete an organization Memory Item entity + api_instance.delete_entity_org_memory_items(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_org_memory_items: %s\n" % e) ``` @@ -6453,8 +6768,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -6478,12 +6792,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_user_groups** -> delete_entity_user_groups(id) - -Delete UserGroup entity +# **delete_entity_organization_settings** +> delete_entity_organization_settings(id) -User Group - creates tree-like structure for categorizing users +Delete Organization Setting entity ### Example @@ -6508,10 +6820,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete UserGroup entity - api_instance.delete_entity_user_groups(id) + # 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_user_groups: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_organization_settings: %s\n" % e) ``` @@ -6543,10 +6855,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_user_settings** -> delete_entity_user_settings(user_id, id) +# **delete_entity_parameters** +> delete_entity_parameters(workspace_id, object_id) -Delete a setting for a user +Delete a Parameter ### Example @@ -6567,15 +6879,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) - user_id = "userId_example" # str | - 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 a setting for a user - api_instance.delete_entity_user_settings(user_id, id) + # Delete a Parameter + api_instance.delete_entity_parameters(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_user_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_parameters: %s\n" % e) ``` @@ -6583,8 +6895,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -6608,12 +6920,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_users** -> delete_entity_users(id) - -Delete User entity +# **delete_entity_report_page_layouts** +> delete_entity_report_page_layouts(workspace_id, object_id) -User - represents entity interacting with platform +Delete a Report Page Layout ### Example @@ -6634,14 +6944,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 User entity - api_instance.delete_entity_users(id) + # Delete a Report Page Layout + api_instance.delete_entity_report_page_layouts(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_users: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_report_page_layouts: %s\n" % e) ``` @@ -6649,7 +6960,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -6673,10 +6985,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_visualization_objects** -> delete_entity_visualization_objects(workspace_id, object_id) +# **delete_entity_report_templates** +> delete_entity_report_templates(workspace_id, object_id) -Delete a Visualization Object +Delete a Report Template ### Example @@ -6702,10 +7014,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Visualization Object - api_instance.delete_entity_visualization_objects(workspace_id, object_id) + # Delete a Report Template + api_instance.delete_entity_report_templates(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_report_templates: %s\n" % e) ``` @@ -6738,10 +7050,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_workspace_color_palettes** -> delete_entity_workspace_color_palettes(workspace_id, object_id) +# **delete_entity_reports** +> delete_entity_reports(workspace_id, object_id) -Delete a Workspace Color Palette +Delete a Report ### Example @@ -6767,10 +7079,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Workspace Color Palette - api_instance.delete_entity_workspace_color_palettes(workspace_id, object_id) + # Delete a Report + api_instance.delete_entity_reports(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_reports: %s\n" % e) ``` @@ -6803,10 +7115,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_workspace_data_filter_settings** -> delete_entity_workspace_data_filter_settings(workspace_id, object_id) +# **delete_entity_themes** +> delete_entity_themes(id) -Delete a Settings for Workspace Data Filter +Delete Theming ### Example @@ -6827,15 +7139,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Settings for Workspace Data Filter - api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) + # Delete Theming + api_instance.delete_entity_themes(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_themes: %s\n" % e) ``` @@ -6843,8 +7154,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -6868,10 +7178,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_workspace_data_filters** -> delete_entity_workspace_data_filters(workspace_id, object_id) +# **delete_entity_user_data_filters** +> delete_entity_user_data_filters(workspace_id, object_id) -Delete a Workspace Data Filter +Delete a User Data Filter ### Example @@ -6897,10 +7207,10 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Delete a Workspace Data Filter - api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) + # Delete a User Data Filter + api_instance.delete_entity_user_data_filters(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_user_data_filters: %s\n" % e) ``` @@ -6933,10 +7243,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) -# **delete_entity_workspace_export_templates** -> delete_entity_workspace_export_templates(workspace_id, object_id) +# **delete_entity_user_groups** +> delete_entity_user_groups(id) -Delete a Workspace Export Template +Delete UserGroup entity + +User Group - creates tree-like structure for categorizing users ### Example @@ -6957,15 +7269,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Workspace Export Template - api_instance.delete_entity_workspace_export_templates(workspace_id, object_id) + # Delete UserGroup entity + api_instance.delete_entity_user_groups(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_user_groups: %s\n" % e) ``` @@ -6973,8 +7284,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -6998,10 +7308,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_workspace_settings** -> delete_entity_workspace_settings(workspace_id, object_id) +# **delete_entity_user_settings** +> delete_entity_user_settings(user_id, id) -Delete a Setting for Workspace +Delete a setting for a user ### Example @@ -7022,15 +7332,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) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + user_id = "userId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Setting for Workspace - api_instance.delete_entity_workspace_settings(workspace_id, object_id) + # Delete a setting for a user + api_instance.delete_entity_user_settings(user_id, id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_user_settings: %s\n" % e) ``` @@ -7038,8 +7348,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **user_id** | **str**| | + **id** | **str**| | ### Return type @@ -7063,10 +7373,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) -# **delete_entity_workspace_themes** -> delete_entity_workspace_themes(workspace_id, object_id) +# **delete_entity_users** +> delete_entity_users(id) -Delete a Workspace Theme +Delete User entity + +User - represents entity interacting with platform ### Example @@ -7087,15 +7399,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set try: - # Delete a Workspace Theme - api_instance.delete_entity_workspace_themes(workspace_id, object_id) + # Delete User entity + api_instance.delete_entity_users(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_users: %s\n" % e) ``` @@ -7103,8 +7414,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | ### Return type @@ -7128,12 +7438,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_workspaces** -> delete_entity_workspaces(id) - -Delete Workspace entity +# **delete_entity_visualization_objects** +> delete_entity_visualization_objects(workspace_id, object_id) -Space of the shared interest +Delete a Visualization Object ### Example @@ -7154,14 +7462,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 Workspace entity - api_instance.delete_entity_workspaces(id) + # Delete a Visualization Object + api_instance.delete_entity_visualization_objects(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->delete_entity_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_visualization_objects: %s\n" % e) ``` @@ -7169,7 +7478,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -7193,10 +7503,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_automations_workspace_automations** -> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() +# **delete_entity_workspace_color_palettes** +> delete_entity_workspace_color_palettes(workspace_id, object_id) -Get all Automations across all Workspaces +Delete a Workspace Color Palette ### Example @@ -7205,7 +7515,6 @@ Get all Automations across all Workspaces import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList 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. @@ -7218,27 +7527,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) - filter = "title==someString;description==someString;workspace.id==321;notificationChannel.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 = [ - "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get all Automations across all Workspaces - api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) + # Delete a Workspace Color Palette + api_instance.delete_entity_workspace_color_palettes(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_automations_workspace_automations: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_color_palettes: %s\n" % e) ``` @@ -7246,16 +7543,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type -[**JsonApiWorkspaceAutomationOutList**](JsonApiWorkspaceAutomationOutList.md) +void (empty response body) ### Authorization @@ -7264,23 +7557,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**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** -> get_all_entities() - -Get all LLM endpoint entities (Removed) +# **delete_entity_workspace_data_filter_settings** +> delete_entity_workspace_data_filter_settings(workspace_id, object_id) -Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. +Delete a Settings for Workspace Data Filter ### Example @@ -7301,18 +7592,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | - # example, this endpoint has no required or optional parameters + # example passing only required values which don't have defaults set try: - # Get all LLM endpoint entities (Removed) - api_instance.get_all_entities() + # Delete a Settings for Workspace Data Filter + api_instance.delete_entity_workspace_data_filter_settings(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_data_filter_settings: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -7332,14 +7629,14 @@ No authorization required | Status code | Description | Response headers | |-------------|-------------|------------------| -**410** | Gone | - | +**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_agents** -> JsonApiAgentOutList get_all_entities_agents() +# **delete_entity_workspace_data_filters** +> delete_entity_workspace_data_filters(workspace_id, object_id) -Get all Agent entities +Delete a Workspace Data Filter ### Example @@ -7348,7 +7645,6 @@ Get all Agent entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_agent_out_list import JsonApiAgentOutList 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. @@ -7361,27 +7657,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) - filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - 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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get all Agent entities - api_response = api_instance.get_all_entities_agents(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) + # Delete a Workspace Data Filter + api_instance.delete_entity_workspace_data_filters(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_agents: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_data_filters: %s\n" % e) ``` @@ -7389,16 +7673,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 - **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 - **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **meta_include** | **[str]**| Include Meta objects. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type -[**JsonApiAgentOutList**](JsonApiAgentOutList.md) +void (empty response body) ### Authorization @@ -7407,21 +7687,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**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_aggregated_facts** -> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) +# **delete_entity_workspace_export_templates** +> delete_entity_workspace_export_templates(workspace_id, object_id) -Get all Aggregated Facts +Delete a Workspace Export Template ### Example @@ -7430,7 +7710,6 @@ Get all Aggregated Facts import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList 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. @@ -7444,37 +7723,14 @@ 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 = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact,sourceAttribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - 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 Aggregated Facts - api_response = api_instance.get_all_entities_aggregated_facts(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_aggregated_facts: %s\n" % e) + object_id = "objectId_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get all Aggregated Facts - api_response = api_instance.get_all_entities_aggregated_facts(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) + # Delete a Workspace Export Template + api_instance.delete_entity_workspace_export_templates(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_aggregated_facts: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_export_templates: %s\n" % e) ``` @@ -7483,18 +7739,11 @@ 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] + **object_id** | **str**| | ### Return type -[**JsonApiAggregatedFactOutList**](JsonApiAggregatedFactOutList.md) +void (empty response body) ### Authorization @@ -7503,21 +7752,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**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_analytical_dashboards** -> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) +# **delete_entity_workspace_settings** +> delete_entity_workspace_settings(workspace_id, object_id) -Get all Dashboards +Delete a Setting for Workspace ### Example @@ -7526,7 +7775,6 @@ Get all Dashboards import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList 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. @@ -7540,37 +7788,14 @@ 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 = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - 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=permissions,origin,accessInfo,page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_analytical_dashboards: %s\n" % e) + object_id = "objectId_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get all Dashboards - api_response = api_instance.get_all_entities_analytical_dashboards(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) + # Delete a Setting for Workspace + api_instance.delete_entity_workspace_settings(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_analytical_dashboards: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_settings: %s\n" % e) ``` @@ -7579,18 +7804,11 @@ 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] + **object_id** | **str**| | ### Return type -[**JsonApiAnalyticalDashboardOutList**](JsonApiAnalyticalDashboardOutList.md) +void (empty response body) ### Authorization @@ -7599,21 +7817,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**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_api_tokens** -> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) +# **delete_entity_workspace_themes** +> delete_entity_workspace_themes(workspace_id, object_id) -List all api tokens for a user +Delete a Workspace Theme ### Example @@ -7622,7 +7840,6 @@ List all api tokens for a user import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList 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. @@ -7635,33 +7852,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) - user_id = "userId_example" # str | - filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 - size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 - sort = [ - "sort_example", - ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - meta_include = [ - "metaInclude=page,all", - ] # [str] | Include Meta objects. (optional) - - # example passing only required values which don't have defaults set - try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_api_tokens: %s\n" % e) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # List all api tokens for a user - api_response = api_instance.get_all_entities_api_tokens(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) - pprint(api_response) + # Delete a Workspace Theme + api_instance.delete_entity_workspace_themes(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_api_tokens: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspace_themes: %s\n" % e) ``` @@ -7669,16 +7868,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_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] - **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] + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type -[**JsonApiApiTokenOutList**](JsonApiApiTokenOutList.md) +void (empty response body) ### Authorization @@ -7687,21 +7882,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**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_attribute_hierarchies** -> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) +# **delete_entity_workspaces** +> delete_entity_workspaces(id) -Get all Attribute Hierarchies +Delete Workspace entity + +Space of the shared interest ### Example @@ -7710,7 +7907,6 @@ Get all Attribute Hierarchies import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList 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. @@ -7723,38 +7919,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "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,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) + id = "/6bUUGjjNSwg0_bs" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get all Attribute Hierarchies - api_response = api_instance.get_all_entities_attribute_hierarchies(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) + # Delete Workspace entity + api_instance.delete_entity_workspaces(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) + print("Exception when calling EntitiesApi->delete_entity_workspaces: %s\n" % e) ``` @@ -7762,19 +7934,11 @@ 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] + **id** | **str**| | ### Return type -[**JsonApiAttributeHierarchyOutList**](JsonApiAttributeHierarchyOutList.md) +void (empty response body) ### Authorization @@ -7783,21 +7947,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**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_attributes** -> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) +# **get_all_automations_workspace_automations** +> JsonApiWorkspaceAutomationOutList get_all_automations_workspace_automations() -Get all Attributes +Get all Automations across all Workspaces ### Example @@ -7806,7 +7970,7 @@ Get all Attributes import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.model.json_api_workspace_automation_out_list import JsonApiWorkspaceAutomationOutList 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. @@ -7819,38 +7983,27 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;workspace.id==321;notificationChannel.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "dataset,defaultView,labels,attributeHierarchies", + "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_attributes: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # Get all Attributes - api_response = api_instance.get_all_entities_attributes(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Automations across all Workspaces + api_response = api_instance.get_all_automations_workspace_automations(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_attributes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_automations_workspace_automations: %s\n" % e) ``` @@ -7858,19 +8011,16 @@ 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 -[**JsonApiAttributeOutList**](JsonApiAttributeOutList.md) +[**JsonApiWorkspaceAutomationOutList**](JsonApiWorkspaceAutomationOutList.md) ### Authorization @@ -7890,10 +8040,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_all_entities_automations** -> JsonApiAutomationOutList get_all_entities_automations(workspace_id) +# **get_all_entities** +> get_all_entities() -Get all Automations +Get all LLM endpoint entities (Removed) + +Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. ### Example @@ -7902,7 +8054,6 @@ Get all Automations import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList 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. @@ -7915,58 +8066,22 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Automations - api_response = api_instance.get_all_entities_automations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_automations: %s\n" % e) - # example passing only required values which don't have defaults set - # and optional values + # example, this endpoint has no required or optional parameters try: - # Get all Automations - api_response = api_instance.get_all_entities_automations(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) + # Get all LLM endpoint entities (Removed) + api_instance.get_all_entities() except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_automations: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities: %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] +This endpoint does not need any parameter. ### Return type -[**JsonApiAutomationOutList**](JsonApiAutomationOutList.md) +void (empty response body) ### Authorization @@ -7975,21 +8090,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_color_palettes** -> JsonApiColorPaletteOutList get_all_entities_color_palettes() +# **get_all_entities_agents** +> JsonApiAgentOutList get_all_entities_agents() -Get all Color Pallettes +Get all Agent entities ### Example @@ -7998,7 +8113,7 @@ Get all Color Pallettes import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList +from gooddata_api_client.model.json_api_agent_out_list import JsonApiAgentOutList 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. @@ -8011,7 +8126,10 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) 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 = [ @@ -8024,11 +8142,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Color Pallettes - api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Agent entities + api_response = api_instance.get_all_entities_agents(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_agents: %s\n" % e) ``` @@ -8037,6 +8155,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -8044,7 +8163,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiColorPaletteOutList**](JsonApiColorPaletteOutList.md) +[**JsonApiAgentOutList**](JsonApiAgentOutList.md) ### Authorization @@ -8064,12 +8183,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_csp_directives** -> JsonApiCspDirectiveOutList get_all_entities_csp_directives() - -Get CSP Directives +# **get_all_entities_aggregated_facts** +> JsonApiAggregatedFactOutList get_all_entities_aggregated_facts(workspace_id) - Context Security Police Directive +Get all Aggregated Facts ### Example @@ -8078,7 +8195,7 @@ Get CSP Directives import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList +from gooddata_api_client.model.json_api_aggregated_fact_out_list import JsonApiAggregatedFactOutList 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. @@ -8091,24 +8208,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 = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,sourceFact,sourceAttribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) 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 Aggregated Facts + api_response = api_instance.get_all_entities_aggregated_facts(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_aggregated_facts: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get CSP Directives - api_response = api_instance.get_all_entities_csp_directives(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Aggregated Facts + api_response = api_instance.get_all_entities_aggregated_facts(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_csp_directives: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_aggregated_facts: %s\n" % e) ``` @@ -8116,15 +8247,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 -[**JsonApiCspDirectiveOutList**](JsonApiCspDirectiveOutList.md) +[**JsonApiAggregatedFactOutList**](JsonApiAggregatedFactOutList.md) ### Authorization @@ -8144,10 +8279,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_custom_application_settings** -> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) +# **get_all_entities_analytical_dashboards** +> JsonApiAnalyticalDashboardOutList get_all_entities_analytical_dashboards(workspace_id) -Get all Custom Application Settings +Get all Dashboards ### Example @@ -8156,7 +8291,7 @@ Get all Custom Application Settings import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList +from gooddata_api_client.model.json_api_analytical_dashboard_out_list import JsonApiAnalyticalDashboardOutList 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. @@ -8171,7 +8306,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "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) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -8179,25 +8317,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,accessInfo,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) + # Get all Dashboards + api_response = api_instance.get_all_entities_analytical_dashboards(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_custom_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_analytical_dashboards: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Custom Application Settings - api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Dashboards + api_response = api_instance.get_all_entities_analytical_dashboards(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_custom_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_analytical_dashboards: %s\n" % e) ``` @@ -8208,6 +8346,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -8216,7 +8355,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiCustomApplicationSettingOutList**](JsonApiCustomApplicationSettingOutList.md) +[**JsonApiAnalyticalDashboardOutList**](JsonApiAnalyticalDashboardOutList.md) ### Authorization @@ -8236,10 +8375,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_custom_geo_collections** -> JsonApiCustomGeoCollectionOutList get_all_entities_custom_geo_collections() +# **get_all_entities_api_tokens** +> JsonApiApiTokenOutList get_all_entities_api_tokens(user_id) -Get all Custom Geo Collections +List all api tokens for a user ### Example @@ -8248,7 +8387,7 @@ Get all Custom Geo Collections import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList +from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList 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. @@ -8261,7 +8400,8 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;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) + user_id = "userId_example" # str | + filter = "bearerToken==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -8271,14 +8411,22 @@ with gooddata_api_client.ApiClient() as api_client: "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) + # example passing only required values which don't have defaults set + try: + # List all api tokens for a user + api_response = api_instance.get_all_entities_api_tokens(user_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_api_tokens: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all Custom Geo Collections - api_response = api_instance.get_all_entities_custom_geo_collections(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # List all api tokens for a user + api_response = api_instance.get_all_entities_api_tokens(user_id, 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_custom_geo_collections: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_api_tokens: %s\n" % e) ``` @@ -8286,6 +8434,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **user_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] **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 @@ -8294,7 +8443,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiCustomGeoCollectionOutList**](JsonApiCustomGeoCollectionOutList.md) +[**JsonApiApiTokenOutList**](JsonApiApiTokenOutList.md) ### Authorization @@ -8314,10 +8463,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_custom_user_application_settings** -> JsonApiCustomUserApplicationSettingOutList get_all_entities_custom_user_application_settings(user_id) +# **get_all_entities_attribute_hierarchies** +> JsonApiAttributeHierarchyOutList get_all_entities_attribute_hierarchies(workspace_id) -List all custom application settings for a user +Get all Attribute Hierarchies ### Example @@ -8326,7 +8475,7 @@ List all custom application settings for a 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_list import JsonApiCustomUserApplicationSettingOutList +from gooddata_api_client.model.json_api_attribute_hierarchy_out_list import JsonApiAttributeHierarchyOutList 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. @@ -8339,33 +8488,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) - user_id = "userId_example" # str | - 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) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;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,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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: - # List all custom application settings for a user - api_response = api_instance.get_all_entities_custom_user_application_settings(user_id) + # Get all Attribute Hierarchies + api_response = api_instance.get_all_entities_attribute_hierarchies(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # List all custom application settings for a user - api_response = api_instance.get_all_entities_custom_user_application_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Attribute Hierarchies + api_response = api_instance.get_all_entities_attribute_hierarchies(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_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_attribute_hierarchies: %s\n" % e) ``` @@ -8373,16 +8527,19 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | + **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 -[**JsonApiCustomUserApplicationSettingOutList**](JsonApiCustomUserApplicationSettingOutList.md) +[**JsonApiAttributeHierarchyOutList**](JsonApiAttributeHierarchyOutList.md) ### Authorization @@ -8402,10 +8559,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_dashboard_plugins** -> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) +# **get_all_entities_attributes** +> JsonApiAttributeOutList get_all_entities_attributes(workspace_id) -Get all Plugins +Get all Attributes ### Example @@ -8414,7 +8571,7 @@ Get all Plugins import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList +from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList 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. @@ -8429,9 +8586,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;dataset.id==321;defaultView.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", + "dataset,defaultView,labels,attributeHierarchies", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -8440,25 +8597,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) + # Get all Attributes + api_response = api_instance.get_all_entities_attributes(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_attributes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Plugins - api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Attributes + api_response = api_instance.get_all_entities_attributes(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_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_attributes: %s\n" % e) ``` @@ -8478,7 +8635,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiDashboardPluginOutList**](JsonApiDashboardPluginOutList.md) +[**JsonApiAttributeOutList**](JsonApiAttributeOutList.md) ### Authorization @@ -8498,10 +8655,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_data_source_identifiers** -> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers() +# **get_all_entities_automations** +> JsonApiAutomationOutList get_all_entities_automations(workspace_id) -Get all Data Source Identifiers +Get all Automations ### Example @@ -8510,7 +8667,7 @@ Get all Data Source Identifiers import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList +from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList 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. @@ -8523,24 +8680,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 = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=permissions,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 Automations + api_response = api_instance.get_all_entities_automations(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_automations: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all Data Source Identifiers - api_response = api_instance.get_all_entities_data_source_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Automations + api_response = api_instance.get_all_entities_automations(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_data_source_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_automations: %s\n" % e) ``` @@ -8548,15 +8719,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 -[**JsonApiDataSourceIdentifierOutList**](JsonApiDataSourceIdentifierOutList.md) +[**JsonApiAutomationOutList**](JsonApiAutomationOutList.md) ### Authorization @@ -8576,12 +8751,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_data_sources** -> JsonApiDataSourceOutList get_all_entities_data_sources() - -Get Data Source entities +# **get_all_entities_color_palettes** +> JsonApiColorPaletteOutList get_all_entities_color_palettes() -Data Source - represents data source for the workspace +Get all Color Pallettes ### Example @@ -8590,7 +8763,7 @@ 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_out_list import JsonApiDataSourceOutList +from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -8603,24 +8776,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;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) + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) meta_include = [ - "metaInclude=permissions,page,all", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set # and optional values try: - # Get Data Source entities - api_response = api_instance.get_all_entities_data_sources(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Color Pallettes + api_response = api_instance.get_all_entities_color_palettes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_color_palettes: %s\n" % e) ``` @@ -8636,7 +8809,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiDataSourceOutList**](JsonApiDataSourceOutList.md) +[**JsonApiColorPaletteOutList**](JsonApiColorPaletteOutList.md) ### Authorization @@ -8656,10 +8829,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_datasets** -> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) +# **get_all_entities_computed_attributes** +> JsonApiComputedAttributeOutList get_all_entities_computed_attributes(workspace_id) -Get all Datasets +Get all Computed Attributes ### Example @@ -8668,7 +8841,7 @@ Get all Datasets import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList 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. @@ -8683,9 +8856,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;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,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -8694,25 +8867,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id) + # Get all Computed Attributes + api_response = api_instance.get_all_entities_computed_attributes(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_computed_attributes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Datasets - api_response = api_instance.get_all_entities_datasets(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Computed Attributes + api_response = api_instance.get_all_entities_computed_attributes(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_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_computed_attributes: %s\n" % e) ``` @@ -8732,7 +8905,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiDatasetOutList**](JsonApiDatasetOutList.md) +[**JsonApiComputedAttributeOutList**](JsonApiComputedAttributeOutList.md) ### Authorization @@ -8752,12 +8925,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_all_entities_entitlements** -> JsonApiEntitlementOutList get_all_entities_entitlements() +# **get_all_entities_csp_directives** +> JsonApiCspDirectiveOutList get_all_entities_csp_directives() -Get Entitlements +Get CSP Directives -Space of the shared interest + Context Security Police Directive ### Example @@ -8766,7 +8939,7 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList +from gooddata_api_client.model.json_api_csp_directive_out_list import JsonApiCspDirectiveOutList 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. @@ -8779,7 +8952,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) 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 = [ @@ -8792,11 +8965,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get Entitlements - api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get CSP Directives + api_response = api_instance.get_all_entities_csp_directives(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_entitlements: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_csp_directives: %s\n" % e) ``` @@ -8812,7 +8985,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiEntitlementOutList**](JsonApiEntitlementOutList.md) +[**JsonApiCspDirectiveOutList**](JsonApiCspDirectiveOutList.md) ### Authorization @@ -8832,10 +9005,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_export_definitions** -> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) +# **get_all_entities_custom_application_settings** +> JsonApiCustomApplicationSettingOutList get_all_entities_custom_application_settings(workspace_id) -Get all Export Definitions +Get all Custom Application Settings ### Example @@ -8844,7 +9017,7 @@ Get all Export Definitions import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList +from gooddata_api_client.model.json_api_custom_application_setting_out_list import JsonApiCustomApplicationSettingOutList 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. @@ -8859,10 +9032,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,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) + 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) 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 = [ @@ -8875,20 +9045,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id) + # Get all Custom Application Settings + api_response = api_instance.get_all_entities_custom_application_settings(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_custom_application_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Export Definitions - api_response = api_instance.get_all_entities_export_definitions(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Custom Application Settings + api_response = api_instance.get_all_entities_custom_application_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_custom_application_settings: %s\n" % e) ``` @@ -8899,7 +9069,6 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -8908,7 +9077,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiExportDefinitionOutList**](JsonApiExportDefinitionOutList.md) +[**JsonApiCustomApplicationSettingOutList**](JsonApiCustomApplicationSettingOutList.md) ### Authorization @@ -8928,10 +9097,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_export_templates** -> JsonApiExportTemplateOutList get_all_entities_export_templates() +# **get_all_entities_custom_geo_collections** +> JsonApiCustomGeoCollectionOutList get_all_entities_custom_geo_collections() -GET all Export Template entities +Get all Custom Geo Collections ### Example @@ -8940,7 +9109,7 @@ GET all Export Template entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList +from gooddata_api_client.model.json_api_custom_geo_collection_out_list import JsonApiCustomGeoCollectionOutList 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. @@ -8953,7 +9122,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -8966,11 +9135,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # GET all Export Template entities - api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Custom Geo Collections + api_response = api_instance.get_all_entities_custom_geo_collections(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_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_custom_geo_collections: %s\n" % e) ``` @@ -8986,7 +9155,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) +[**JsonApiCustomGeoCollectionOutList**](JsonApiCustomGeoCollectionOutList.md) ### Authorization @@ -9006,10 +9175,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_facts** -> JsonApiFactOutList get_all_entities_facts(workspace_id) +# **get_all_entities_custom_user_application_settings** +> JsonApiCustomUserApplicationSettingOutList get_all_entities_custom_user_application_settings(user_id) -Get all Facts +List all custom application settings for a user ### Example @@ -9018,7 +9187,7 @@ Get all Facts import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList +from gooddata_api_client.model.json_api_custom_user_application_setting_out_list import JsonApiCustomUserApplicationSettingOutList 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. @@ -9031,38 +9200,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) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + user_id = "userId_example" # str | + 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) 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", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(workspace_id) + # List all custom application settings for a user + api_response = api_instance.get_all_entities_custom_user_application_settings(user_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_custom_user_application_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Facts - api_response = api_instance.get_all_entities_facts(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) + # List all custom application settings for a user + api_response = api_instance.get_all_entities_custom_user_application_settings(user_id, 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_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_custom_user_application_settings: %s\n" % e) ``` @@ -9070,19 +9234,16 @@ 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" + **user_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **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 -[**JsonApiFactOutList**](JsonApiFactOutList.md) +[**JsonApiCustomUserApplicationSettingOutList**](JsonApiCustomUserApplicationSettingOutList.md) ### Authorization @@ -9102,10 +9263,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_filter_contexts** -> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) +# **get_all_entities_dashboard_plugins** +> JsonApiDashboardPluginOutList get_all_entities_dashboard_plugins(workspace_id) -Get all Filter Context +Get all Plugins ### Example @@ -9114,7 +9275,7 @@ Get all Filter Context import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList +from gooddata_api_client.model.json_api_dashboard_plugin_out_list import JsonApiDashboardPluginOutList 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. @@ -9129,9 +9290,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;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,datasets,labels", + "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 @@ -9145,20 +9306,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Filter Context - api_response = api_instance.get_all_entities_filter_contexts(workspace_id) + # Get all Plugins + api_response = api_instance.get_all_entities_dashboard_plugins(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_dashboard_plugins: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Filter Context - api_response = api_instance.get_all_entities_filter_contexts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Plugins + api_response = api_instance.get_all_entities_dashboard_plugins(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_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_dashboard_plugins: %s\n" % e) ``` @@ -9178,7 +9339,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiFilterContextOutList**](JsonApiFilterContextOutList.md) +[**JsonApiDashboardPluginOutList**](JsonApiDashboardPluginOutList.md) ### Authorization @@ -9198,10 +9359,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_filter_views** -> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) +# **get_all_entities_data_source_identifiers** +> JsonApiDataSourceIdentifierOutList get_all_entities_data_source_identifiers() -Get all Filter views +Get all Data Source Identifiers ### Example @@ -9210,7 +9371,7 @@ Get all Filter views import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList +from gooddata_api_client.model.json_api_data_source_identifier_out_list import JsonApiDataSourceIdentifierOutList 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. @@ -9223,38 +9384,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.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 = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "name==someString;schema==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=page,all", + "metaInclude=permissions,page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_filter_views: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # Get all Filter views - api_response = api_instance.get_all_entities_filter_views(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Data Source Identifiers + api_response = api_instance.get_all_entities_data_source_identifiers(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_filter_views: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_data_source_identifiers: %s\n" % e) ``` @@ -9262,19 +9409,15 @@ 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 -[**JsonApiFilterViewOutList**](JsonApiFilterViewOutList.md) +[**JsonApiDataSourceIdentifierOutList**](JsonApiDataSourceIdentifierOutList.md) ### Authorization @@ -9294,10 +9437,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_all_entities_fiscal_calendars** -> JsonApiFiscalCalendarOutList get_all_entities_fiscal_calendars(workspace_id) +# **get_all_entities_data_sources** +> JsonApiDataSourceOutList get_all_entities_data_sources() -Get all Fiscal Calendars +Get Data Source entities + +Data Source - represents data source for the workspace ### Example @@ -9306,7 +9451,7 @@ Get all Fiscal Calendars import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList +from gooddata_api_client.model.json_api_data_source_out_list import JsonApiDataSourceOutList 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. @@ -9319,35 +9464,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "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) 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=permissions,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set + # and optional values try: - # Get all Fiscal Calendars - api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id) + # Get Data Source entities + api_response = api_instance.get_all_entities_data_sources(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_fiscal_calendars: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # Get all Fiscal Calendars - api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_fiscal_calendars: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_data_sources: %s\n" % e) ``` @@ -9355,18 +9489,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiFiscalCalendarOutList**](JsonApiFiscalCalendarOutList.md) +[**JsonApiDataSourceOutList**](JsonApiDataSourceOutList.md) ### Authorization @@ -9386,10 +9517,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_identity_providers** -> JsonApiIdentityProviderOutList get_all_entities_identity_providers() +# **get_all_entities_datasets** +> JsonApiDatasetOutList get_all_entities_datasets(workspace_id) -Get all Identity Providers +Get all Datasets ### Example @@ -9398,7 +9529,7 @@ Get all Identity Providers import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList +from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList 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. @@ -9411,24 +9542,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 = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "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) 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 Datasets + api_response = api_instance.get_all_entities_datasets(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_datasets: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all Identity Providers - api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Datasets + api_response = api_instance.get_all_entities_datasets(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_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_datasets: %s\n" % e) ``` @@ -9436,15 +9581,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 -[**JsonApiIdentityProviderOutList**](JsonApiIdentityProviderOutList.md) +[**JsonApiDatasetOutList**](JsonApiDatasetOutList.md) ### Authorization @@ -9464,10 +9613,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_all_entities_ip_allowlist_policies** -> JsonApiIpAllowlistPolicyOutList get_all_entities_ip_allowlist_policies() +# **get_all_entities_entitlements** +> JsonApiEntitlementOutList get_all_entities_entitlements() -Get all IpAllowlistPolicy entities +Get Entitlements + +Space of the shared interest ### Example @@ -9476,7 +9627,7 @@ Get all IpAllowlistPolicy entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_ip_allowlist_policy_out_list import JsonApiIpAllowlistPolicyOutList +from gooddata_api_client.model.json_api_entitlement_out_list import JsonApiEntitlementOutList 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. @@ -9489,10 +9640,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "allowedSources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "users,userGroups", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 = [ @@ -9505,11 +9653,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all IpAllowlistPolicy entities - api_response = api_instance.get_all_entities_ip_allowlist_policies(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get Entitlements + api_response = api_instance.get_all_entities_entitlements(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_ip_allowlist_policies: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_entitlements: %s\n" % e) ``` @@ -9518,7 +9666,6 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -9526,7 +9673,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiIpAllowlistPolicyOutList**](JsonApiIpAllowlistPolicyOutList.md) +[**JsonApiEntitlementOutList**](JsonApiEntitlementOutList.md) ### Authorization @@ -9546,12 +9693,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_jwks** -> JsonApiJwkOutList get_all_entities_jwks() - -Get all Jwks +# **get_all_entities_export_definitions** +> JsonApiExportDefinitionOutList get_all_entities_export_definitions(workspace_id) -Returns all JSON web keys - used to verify JSON web tokens (Jwts) +Get all Export Definitions ### Example @@ -9560,7 +9705,7 @@ Returns all JSON web keys - used to verify JSON web tokens (Jwts) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList +from gooddata_api_client.model.json_api_export_definition_out_list import JsonApiExportDefinitionOutList 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. @@ -9573,24 +9718,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==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "visualizationObject,analyticalDashboard,automation,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 Export Definitions + api_response = api_instance.get_all_entities_export_definitions(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_export_definitions: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all Jwks - api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Export Definitions + api_response = api_instance.get_all_entities_export_definitions(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_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_export_definitions: %s\n" % e) ``` @@ -9598,15 +9757,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 -[**JsonApiJwkOutList**](JsonApiJwkOutList.md) +[**JsonApiExportDefinitionOutList**](JsonApiExportDefinitionOutList.md) ### Authorization @@ -9626,10 +9789,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_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutList get_all_entities_knowledge_recommendations(workspace_id) +# **get_all_entities_export_templates** +> JsonApiExportTemplateOutList get_all_entities_export_templates() -Get all Knowledge Recommendations +GET all Export Template entities ### Example @@ -9638,7 +9801,7 @@ Get all Knowledge Recommendations import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.model.json_api_export_template_out_list import JsonApiExportTemplateOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -9651,38 +9814,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,page,all", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # Get all Knowledge Recommendations - api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_knowledge_recommendations: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # Get all Knowledge Recommendations - api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # GET all Export Template entities + api_response = api_instance.get_all_entities_export_templates(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_knowledge_recommendations: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_export_templates: %s\n" % e) ``` @@ -9690,19 +9839,15 @@ 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 -[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) +[**JsonApiExportTemplateOutList**](JsonApiExportTemplateOutList.md) ### Authorization @@ -9722,10 +9867,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_labels** -> JsonApiLabelOutList get_all_entities_labels(workspace_id) +# **get_all_entities_facts** +> JsonApiFactOutList get_all_entities_facts(workspace_id) -Get all Labels +Get all Facts ### Example @@ -9734,7 +9879,7 @@ Get all Labels import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList +from gooddata_api_client.model.json_api_fact_out_list import JsonApiFactOutList 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. @@ -9749,9 +9894,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;dataset.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 = [ - "attribute", + "dataset", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -9760,25 +9905,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id) + # Get all Facts + api_response = api_instance.get_all_entities_facts(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_labels: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_facts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Labels - api_response = api_instance.get_all_entities_labels(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Facts + api_response = api_instance.get_all_entities_facts(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_labels: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_facts: %s\n" % e) ``` @@ -9798,7 +9943,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiLabelOutList**](JsonApiLabelOutList.md) +[**JsonApiFactOutList**](JsonApiFactOutList.md) ### Authorization @@ -9818,10 +9963,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_llm_providers** -> JsonApiLlmProviderOutList get_all_entities_llm_providers() +# **get_all_entities_filter_contexts** +> JsonApiFilterContextOutList get_all_entities_filter_contexts(workspace_id) -Get all LLM Provider entities +Get all Filter Context ### Example @@ -9830,7 +9975,7 @@ Get all LLM Provider entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList +from gooddata_api_client.model.json_api_filter_context_out_list import JsonApiFilterContextOutList 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. @@ -9843,24 +9988,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 = "name==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) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,datasets,labels,computedAttributes,metrics,facts", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Filter Context + api_response = api_instance.get_all_entities_filter_contexts(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_filter_contexts: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all LLM Provider entities - api_response = api_instance.get_all_entities_llm_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Filter Context + api_response = api_instance.get_all_entities_filter_contexts(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_llm_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_filter_contexts: %s\n" % e) ``` @@ -9868,15 +10027,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 -[**JsonApiLlmProviderOutList**](JsonApiLlmProviderOutList.md) +[**JsonApiFilterContextOutList**](JsonApiFilterContextOutList.md) ### Authorization @@ -9896,10 +10059,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_memory_items** -> JsonApiMemoryItemOutList get_all_entities_memory_items(workspace_id) +# **get_all_entities_filter_views** +> JsonApiFilterViewOutList get_all_entities_filter_views(workspace_id) -Get all Memory Items +Get all Filter views ### Example @@ -9908,7 +10071,7 @@ Get all Memory Items import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.model.json_api_filter_view_out_list import JsonApiFilterViewOutList 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. @@ -9923,9 +10086,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.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", + "analyticalDashboard,user", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -9934,25 +10097,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Memory Items - api_response = api_instance.get_all_entities_memory_items(workspace_id) + # Get all Filter views + api_response = api_instance.get_all_entities_filter_views(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_filter_views: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Memory Items - api_response = api_instance.get_all_entities_memory_items(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Filter views + api_response = api_instance.get_all_entities_filter_views(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_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_filter_views: %s\n" % e) ``` @@ -9972,7 +10135,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) +[**JsonApiFilterViewOutList**](JsonApiFilterViewOutList.md) ### Authorization @@ -9992,10 +10155,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_metrics** -> JsonApiMetricOutList get_all_entities_metrics(workspace_id) +# **get_all_entities_fiscal_calendars** +> JsonApiFiscalCalendarOutList get_all_entities_fiscal_calendars(workspace_id) -Get all Metrics +Get all Fiscal Calendars ### Example @@ -10004,7 +10167,7 @@ Get all Metrics import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList +from gooddata_api_client.model.json_api_fiscal_calendar_out_list import JsonApiFiscalCalendarOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10019,10 +10182,7 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10030,25 +10190,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id) + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_metrics: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_fiscal_calendars: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Metrics - api_response = api_instance.get_all_entities_metrics(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Fiscal Calendars + api_response = api_instance.get_all_entities_fiscal_calendars(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_metrics: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_fiscal_calendars: %s\n" % e) ``` @@ -10059,7 +10219,6 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -10068,7 +10227,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiMetricOutList**](JsonApiMetricOutList.md) +[**JsonApiFiscalCalendarOutList**](JsonApiFiscalCalendarOutList.md) ### Authorization @@ -10088,10 +10247,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_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers() +# **get_all_entities_identity_providers** +> JsonApiIdentityProviderOutList get_all_entities_identity_providers() -Get all Notification Channel Identifier entities +Get all Identity Providers ### Example @@ -10100,7 +10259,7 @@ Get all Notification Channel Identifier entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList +from gooddata_api_client.model.json_api_identity_provider_out_list import JsonApiIdentityProviderOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10113,7 +10272,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10126,11 +10285,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Notification Channel Identifier entities - api_response = api_instance.get_all_entities_notification_channel_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Identity Providers + api_response = api_instance.get_all_entities_identity_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_notification_channel_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_identity_providers: %s\n" % e) ``` @@ -10146,7 +10305,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiNotificationChannelIdentifierOutList**](JsonApiNotificationChannelIdentifierOutList.md) +[**JsonApiIdentityProviderOutList**](JsonApiIdentityProviderOutList.md) ### Authorization @@ -10166,10 +10325,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_notification_channels** -> JsonApiNotificationChannelOutList get_all_entities_notification_channels() +# **get_all_entities_ip_allowlist_policies** +> JsonApiIpAllowlistPolicyOutList get_all_entities_ip_allowlist_policies() -Get all Notification Channel entities +Get all IpAllowlistPolicy entities ### Example @@ -10178,7 +10337,7 @@ Get all Notification Channel entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList +from gooddata_api_client.model.json_api_ip_allowlist_policy_out_list import JsonApiIpAllowlistPolicyOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10191,7 +10350,10 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "allowedSources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "users,userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10204,11 +10366,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Notification Channel entities - api_response = api_instance.get_all_entities_notification_channels(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all IpAllowlistPolicy entities + api_response = api_instance.get_all_entities_ip_allowlist_policies(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_notification_channels: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_ip_allowlist_policies: %s\n" % e) ``` @@ -10217,6 +10379,7 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -10224,7 +10387,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiNotificationChannelOutList**](JsonApiNotificationChannelOutList.md) +[**JsonApiIpAllowlistPolicyOutList**](JsonApiIpAllowlistPolicyOutList.md) ### Authorization @@ -10244,10 +10407,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_all_entities_org_memory_items** -> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() +# **get_all_entities_jwks** +> JsonApiJwkOutList get_all_entities_jwks() -Get all organization Memory Item entities +Get all Jwks + +Returns all JSON web keys - used to verify JSON web tokens (Jwts) ### Example @@ -10256,7 +10421,7 @@ Get all organization Memory Item entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_jwk_out_list import JsonApiJwkOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10269,10 +10434,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "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) + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10285,11 +10447,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all organization Memory Item entities - api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Jwks + api_response = api_instance.get_all_entities_jwks(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_org_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_jwks: %s\n" % e) ``` @@ -10298,7 +10460,6 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -10306,7 +10467,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) +[**JsonApiJwkOutList**](JsonApiJwkOutList.md) ### Authorization @@ -10326,10 +10487,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_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutList get_all_entities_knowledge_recommendations(workspace_id) -Get Organization Setting entities +Get all Knowledge Recommendations ### Example @@ -10338,7 +10499,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_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList 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. @@ -10351,24 +10512,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 = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "metric,analyticalDashboard", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) 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 Knowledge Recommendations + api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_knowledge_recommendations: %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 Knowledge Recommendations + api_response = api_instance.get_all_entities_knowledge_recommendations(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_knowledge_recommendations: %s\n" % e) ``` @@ -10376,15 +10551,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) +[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) ### Authorization @@ -10404,10 +10583,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_parameters** -> JsonApiParameterOutList get_all_entities_parameters(workspace_id) +# **get_all_entities_labels** +> JsonApiLabelOutList get_all_entities_labels(workspace_id) -Get all Parameters +Get all Labels ### Example @@ -10416,7 +10595,7 @@ Get all Parameters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_parameter_out_list import JsonApiParameterOutList +from gooddata_api_client.model.json_api_label_out_list import JsonApiLabelOutList 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. @@ -10431,9 +10610,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;attribute.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", + "attribute", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -10442,25 +10621,25 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get all Parameters - api_response = api_instance.get_all_entities_parameters(workspace_id) + # Get all Labels + api_response = api_instance.get_all_entities_labels(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_labels: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Parameters - api_response = api_instance.get_all_entities_parameters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Labels + api_response = api_instance.get_all_entities_labels(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_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_labels: %s\n" % e) ``` @@ -10480,7 +10659,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiParameterOutList**](JsonApiParameterOutList.md) +[**JsonApiLabelOutList**](JsonApiLabelOutList.md) ### Authorization @@ -10500,10 +10679,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_themes** -> JsonApiThemeOutList get_all_entities_themes() +# **get_all_entities_llm_providers** +> JsonApiLlmProviderOutList get_all_entities_llm_providers() -Get all Theming entities +Get all LLM Provider entities ### Example @@ -10512,7 +10691,7 @@ Get all Theming entities import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList +from gooddata_api_client.model.json_api_llm_provider_out_list import JsonApiLlmProviderOutList 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. @@ -10525,7 +10704,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10538,11 +10717,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get all Theming entities - api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all LLM Provider entities + api_response = api_instance.get_all_entities_llm_providers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_llm_providers: %s\n" % e) ``` @@ -10558,7 +10737,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiThemeOutList**](JsonApiThemeOutList.md) +[**JsonApiLlmProviderOutList**](JsonApiLlmProviderOutList.md) ### Authorization @@ -10578,10 +10757,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_user_data_filters** -> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) +# **get_all_entities_memory_items** +> JsonApiMemoryItemOutList get_all_entities_memory_items(workspace_id) -Get all User Data Filters +Get all Memory Items ### Example @@ -10590,7 +10769,7 @@ Get all User Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList 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. @@ -10605,9 +10784,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "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 @@ -10621,20 +10800,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id) + # Get all Memory Items + api_response = api_instance.get_all_entities_memory_items(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all User Data Filters - api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Memory Items + api_response = api_instance.get_all_entities_memory_items(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_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_memory_items: %s\n" % e) ``` @@ -10654,7 +10833,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiUserDataFilterOutList**](JsonApiUserDataFilterOutList.md) +[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) ### Authorization @@ -10674,12 +10853,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_user_groups** -> JsonApiUserGroupOutList get_all_entities_user_groups() - -Get UserGroup entities +# **get_all_entities_metrics** +> JsonApiMetricOutList get_all_entities_metrics(workspace_id) -User Group - creates tree-like structure for categorizing users +Get all Metrics ### Example @@ -10688,7 +10865,7 @@ User Group - creates tree-like structure for categorizing users import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList +from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList 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. @@ -10701,27 +10878,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 = "name==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) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;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 = [ - "parents", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) + # example passing only required values which don't have defaults set + try: + # Get all Metrics + api_response = api_instance.get_all_entities_metrics(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_all_entities_metrics: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get UserGroup entities - api_response = api_instance.get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Metrics + api_response = api_instance.get_all_entities_metrics(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_user_groups: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_metrics: %s\n" % e) ``` @@ -10729,16 +10917,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 -[**JsonApiUserGroupOutList**](JsonApiUserGroupOutList.md) +[**JsonApiMetricOutList**](JsonApiMetricOutList.md) ### Authorization @@ -10758,12 +10949,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_user_identifiers** -> JsonApiUserIdentifierOutList get_all_entities_user_identifiers() - -Get UserIdentifier entities +# **get_all_entities_notification_channel_identifiers** +> JsonApiNotificationChannelIdentifierOutList get_all_entities_notification_channel_identifiers() -UserIdentifier - represents entity interacting with platform +Get all Notification Channel Identifier entities ### Example @@ -10772,7 +10961,7 @@ UserIdentifier - represents entity interacting with platform import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList +from gooddata_api_client.model.json_api_notification_channel_identifier_out_list import JsonApiNotificationChannelIdentifierOutList 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. @@ -10785,7 +10974,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10798,11 +10987,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get UserIdentifier entities - api_response = api_instance.get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Notification Channel Identifier entities + api_response = api_instance.get_all_entities_notification_channel_identifiers(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_user_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_notification_channel_identifiers: %s\n" % e) ``` @@ -10818,7 +11007,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiUserIdentifierOutList**](JsonApiUserIdentifierOutList.md) +[**JsonApiNotificationChannelIdentifierOutList**](JsonApiNotificationChannelIdentifierOutList.md) ### Authorization @@ -10838,10 +11027,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_user_settings** -> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) +# **get_all_entities_notification_channels** +> JsonApiNotificationChannelOutList get_all_entities_notification_channels() -List all settings for a user +Get all Notification Channel entities ### Example @@ -10850,7 +11039,7 @@ List all settings for a user import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList +from gooddata_api_client.model.json_api_notification_channel_out_list import JsonApiNotificationChannelOutList 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. @@ -10863,8 +11052,7 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - user_id = "userId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -10874,22 +11062,14 @@ with gooddata_api_client.ApiClient() as api_client: "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_user_settings: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # List all settings for a user - api_response = api_instance.get_all_entities_user_settings(user_id, filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Notification Channel entities + api_response = api_instance.get_all_entities_notification_channels(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_user_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_notification_channels: %s\n" % e) ``` @@ -10897,7 +11077,6 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_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] **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 @@ -10906,7 +11085,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiUserSettingOutList**](JsonApiUserSettingOutList.md) +[**JsonApiNotificationChannelOutList**](JsonApiNotificationChannelOutList.md) ### Authorization @@ -10926,12 +11105,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_users** -> JsonApiUserOutList get_all_entities_users() - -Get User entities +# **get_all_entities_org_memory_items** +> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() -User - represents entity interacting with platform +Get all organization Memory Item entities ### Example @@ -10940,7 +11117,7 @@ User - represents entity interacting with platform import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -10953,9 +11130,9 @@ 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 = "authenticationId==someString;firstname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;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 = [ - "userGroups", + "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 @@ -10969,11 +11146,11 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set # and optional values try: - # Get User entities - api_response = api_instance.get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all organization Memory Item entities + api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_users: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_org_memory_items: %s\n" % e) ``` @@ -10990,7 +11167,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiUserOutList**](JsonApiUserOutList.md) +[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) ### Authorization @@ -11010,10 +11187,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_visualization_objects** -> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) +# **get_all_entities_organization_settings** +> JsonApiOrganizationSettingOutList get_all_entities_organization_settings() -Get all Visualization Objects +Get Organization Setting entities ### Example @@ -11022,7 +11199,7 @@ Get all Visualization Objects import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList +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. @@ -11035,38 +11212,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,page,all", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_visualization_objects: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # Get all Visualization Objects - api_response = api_instance.get_all_entities_visualization_objects(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get 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_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_organization_settings: %s\n" % e) ``` @@ -11074,19 +11237,15 @@ 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 -[**JsonApiVisualizationObjectOutList**](JsonApiVisualizationObjectOutList.md) +[**JsonApiOrganizationSettingOutList**](JsonApiOrganizationSettingOutList.md) ### Authorization @@ -11106,10 +11265,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_color_palettes** -> JsonApiWorkspaceColorPaletteOutList get_all_entities_workspace_color_palettes(workspace_id) +# **get_all_entities_parameters** +> JsonApiParameterOutList get_all_entities_parameters(workspace_id) -Get all Workspace Color Palettes +Get all Parameters ### Example @@ -11118,7 +11277,7 @@ Get all Workspace Color Palettes import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList +from gooddata_api_client.model.json_api_parameter_out_list import JsonApiParameterOutList 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. @@ -11133,7 +11292,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -11146,20 +11308,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Workspace Color Palettes - api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id) + # Get all Parameters + api_response = api_instance.get_all_entities_parameters(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_parameters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Workspace Color Palettes - api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Parameters + api_response = api_instance.get_all_entities_parameters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_parameters: %s\n" % e) ``` @@ -11170,6 +11332,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -11178,7 +11341,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceColorPaletteOutList**](JsonApiWorkspaceColorPaletteOutList.md) +[**JsonApiParameterOutList**](JsonApiParameterOutList.md) ### Authorization @@ -11198,10 +11361,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) +# **get_all_entities_report_page_layouts** +> JsonApiReportPageLayoutOutList get_all_entities_report_page_layouts(workspace_id) -Get all Settings for Workspace Data Filters +Get all Report Page Layouts ### Example @@ -11210,7 +11373,7 @@ Get all Settings for Workspace Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList 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. @@ -11225,9 +11388,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + 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 = [ - "workspaceDataFilter", + "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 @@ -11241,20 +11404,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) + # Get all Report Page Layouts + api_response = api_instance.get_all_entities_report_page_layouts(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Settings for Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Report Page Layouts + api_response = api_instance.get_all_entities_report_page_layouts(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_report_page_layouts: %s\n" % e) ``` @@ -11274,7 +11437,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) +[**JsonApiReportPageLayoutOutList**](JsonApiReportPageLayoutOutList.md) ### Authorization @@ -11294,10 +11457,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) +# **get_all_entities_report_templates** +> JsonApiReportTemplateOutList get_all_entities_report_templates(workspace_id) -Get all Workspace Data Filters +Get all Report Templates ### Example @@ -11306,7 +11469,7 @@ Get all Workspace Data Filters import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList 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. @@ -11321,9 +11484,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;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 = [ - "filterSettings", + "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 @@ -11337,20 +11500,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) + # Get all Report Templates + api_response = api_instance.get_all_entities_report_templates(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Workspace Data Filters - api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Report Templates + api_response = api_instance.get_all_entities_report_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_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_report_templates: %s\n" % e) ``` @@ -11370,7 +11533,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) +[**JsonApiReportTemplateOutList**](JsonApiReportTemplateOutList.md) ### Authorization @@ -11390,10 +11553,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_export_templates** -> JsonApiWorkspaceExportTemplateOutList get_all_entities_workspace_export_templates(workspace_id) +# **get_all_entities_reports** +> JsonApiReportOutList get_all_entities_reports(workspace_id) -Get all Workspace Export Templates +Get all Reports ### Example @@ -11402,7 +11565,7 @@ Get all Workspace Export Templates import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList +from gooddata_api_client.model.json_api_report_out_list import JsonApiReportOutList 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. @@ -11417,7 +11580,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ @@ -11430,20 +11596,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Workspace Export Templates - api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id) + # Get all Reports + api_response = api_instance.get_all_entities_reports(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Workspace Export Templates - api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Reports + api_response = api_instance.get_all_entities_reports(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_reports: %s\n" % e) ``` @@ -11454,6 +11620,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -11462,7 +11629,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceExportTemplateOutList**](JsonApiWorkspaceExportTemplateOutList.md) +[**JsonApiReportOutList**](JsonApiReportOutList.md) ### Authorization @@ -11482,10 +11649,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_settings** -> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) +# **get_all_entities_themes** +> JsonApiThemeOutList get_all_entities_themes() -Get all Setting for Workspaces +Get all Theming entities ### Example @@ -11494,7 +11661,7 @@ Get all Setting for Workspaces import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList +from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -11507,35 +11674,24 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 sort = [ "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,page,all", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) - # example passing only required values which don't have defaults set - try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) - # example passing only required values which don't have defaults set # and optional values try: - # Get all Setting for Workspaces - api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Theming entities + api_response = api_instance.get_all_entities_themes(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_themes: %s\n" % e) ``` @@ -11543,18 +11699,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) +[**JsonApiThemeOutList**](JsonApiThemeOutList.md) ### Authorization @@ -11574,10 +11727,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_all_entities_workspace_themes** -> JsonApiWorkspaceThemeOutList get_all_entities_workspace_themes(workspace_id) +# **get_all_entities_user_data_filters** +> JsonApiUserDataFilterOutList get_all_entities_user_data_filters(workspace_id) -Get all Workspace Themes +Get all User Data Filters ### Example @@ -11586,7 +11739,7 @@ Get all Workspace Themes import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList +from gooddata_api_client.model.json_api_user_data_filter_out_list import JsonApiUserDataFilterOutList 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. @@ -11601,7 +11754,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -11614,20 +11770,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Workspace Themes - api_response = api_instance.get_all_entities_workspace_themes(workspace_id) + # Get all User Data Filters + api_response = api_instance.get_all_entities_user_data_filters(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_user_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Workspace Themes - api_response = api_instance.get_all_entities_workspace_themes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all User Data Filters + api_response = api_instance.get_all_entities_user_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_user_data_filters: %s\n" % e) ``` @@ -11638,6 +11794,7 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] @@ -11646,7 +11803,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceThemeOutList**](JsonApiWorkspaceThemeOutList.md) +[**JsonApiUserDataFilterOutList**](JsonApiUserDataFilterOutList.md) ### Authorization @@ -11666,12 +11823,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_all_entities_workspaces** -> JsonApiWorkspaceOutList get_all_entities_workspaces() +# **get_all_entities_user_groups** +> JsonApiUserGroupOutList get_all_entities_user_groups() -Get Workspace entities +Get UserGroup entities -Space of the shared interest +User Group - creates tree-like structure for categorizing users ### Example @@ -11680,7 +11837,7 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList +from gooddata_api_client.model.json_api_user_group_out_list import JsonApiUserGroupOutList 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. @@ -11693,9 +11850,9 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==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 = [ - "parent", + "parents", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -11703,17 +11860,17 @@ with gooddata_api_client.ApiClient() as api_client: "sort_example", ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) meta_include = [ - "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + "metaInclude=page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set # and optional values try: - # Get Workspace entities - api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get UserGroup entities + api_response = api_instance.get_all_entities_user_groups(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_entities_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_user_groups: %s\n" % e) ``` @@ -11730,7 +11887,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiWorkspaceOutList**](JsonApiWorkspaceOutList.md) +[**JsonApiUserGroupOutList**](JsonApiUserGroupOutList.md) ### Authorization @@ -11750,12 +11907,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_all_options** -> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_options() +# **get_all_entities_user_identifiers** +> JsonApiUserIdentifierOutList get_all_entities_user_identifiers() -Links for all configuration options +Get UserIdentifier entities -Retrieves links for all options for different configurations. +UserIdentifier - represents entity interacting with platform ### Example @@ -11764,6 +11921,7 @@ Retrieves links for all options for different configurations. import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList 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. @@ -11776,23 +11934,40 @@ 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) - - # example, this endpoint has no required or optional parameters - try: - # Links for all configuration options - api_response = api_instance.get_all_options() - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_all_options: %s\n" % e) + filter = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + 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 UserIdentifier entities + api_response = api_instance.get_all_entities_user_identifiers(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_user_identifiers: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +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 -**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** +[**JsonApiUserIdentifierOutList**](JsonApiUserIdentifierOutList.md) ### Authorization @@ -11801,23 +11976,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Links for all configuration options. | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_data_source_drivers** -> {str: (str,)} get_data_source_drivers() - -Get all available data source drivers +# **get_all_entities_user_settings** +> JsonApiUserSettingOutList get_all_entities_user_settings(user_id) -Retrieves a list of all supported data sources along with information about the used drivers. +List all settings for a user ### Example @@ -11826,6 +11999,7 @@ Retrieves a list of all supported data sources along with information about the import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_user_setting_out_list import JsonApiUserSettingOutList 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. @@ -11838,23 +12012,50 @@ 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 | + 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, this endpoint has no required or optional parameters + # example passing only required values which don't have defaults set try: - # Get all available data source drivers - api_response = api_instance.get_data_source_drivers() + # List all settings for a user + api_response = api_instance.get_all_entities_user_settings(user_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_data_source_drivers: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_user_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # List all settings for a user + api_response = api_instance.get_all_entities_user_settings(user_id, 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_user_settings: %s\n" % e) ``` ### Parameters -This endpoint does not need any parameter. + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_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] + **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 -**{str: (str,)}** +[**JsonApiUserSettingOutList**](JsonApiUserSettingOutList.md) ### Authorization @@ -11863,23 +12064,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | A list of all available data source drivers. | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity** -> get_entity(id) +# **get_all_entities_users** +> JsonApiUserOutList get_all_entities_users() -Get LLM endpoint entity (Removed) +Get User entities -Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. +User - represents entity interacting with platform ### Example @@ -11888,6 +12089,7 @@ Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 4 import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_user_out_list import JsonApiUserOutList 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. @@ -11900,14 +12102,27 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "id_example" # str | + filter = "authenticationId==someString;firstname==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 = [ + "userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "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 LLM endpoint entity (Removed) - api_instance.get_entity(id) + # Get User entities + api_response = api_instance.get_all_entities_users(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_users: %s\n" % e) ``` @@ -11915,11 +12130,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiUserOutList**](JsonApiUserOutList.md) ### Authorization @@ -11928,21 +12148,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**410** | Gone | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_agents** -> JsonApiAgentOutDocument get_entity_agents(id) +# **get_all_entities_visualization_objects** +> JsonApiVisualizationObjectOutList get_all_entities_visualization_objects(workspace_id) -Get Agent entity +Get all Visualization Objects ### Example @@ -11951,7 +12171,7 @@ Get Agent entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument +from gooddata_api_client.model.json_api_visualization_object_out_list import JsonApiVisualizationObjectOutList 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. @@ -11964,28 +12184,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) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,userGroups", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + 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=permissions,origin,page,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Agent entity - api_response = api_instance.get_entity_agents(id) + # Get all Visualization Objects + api_response = api_instance.get_all_entities_visualization_objects(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_visualization_objects: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Agent entity - api_response = api_instance.get_entity_agents(id, filter=filter, include=include) + # Get all Visualization Objects + api_response = api_instance.get_all_entities_visualization_objects(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_entity_agents: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_visualization_objects: %s\n" % e) ``` @@ -11993,13 +12223,19 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **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 -[**JsonApiAgentOutDocument**](JsonApiAgentOutDocument.md) +[**JsonApiVisualizationObjectOutList**](JsonApiVisualizationObjectOutList.md) ### Authorization @@ -12019,10 +12255,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_aggregated_facts** -> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) +# **get_all_entities_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutList get_all_entities_workspace_color_palettes(workspace_id) -Get an Aggregated Fact +Get all Workspace Color Palettes ### Example @@ -12031,7 +12267,7 @@ Get an Aggregated Fact import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument +from gooddata_api_client.model.json_api_workspace_color_palette_out_list import JsonApiWorkspaceColorPaletteOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12045,32 +12281,34 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,sourceFact,sourceAttribute", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get an Aggregated Fact - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an Aggregated Fact - api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Workspace Color Palettes + api_response = api_instance.get_all_entities_workspace_color_palettes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_color_palettes: %s\n" % e) ``` @@ -12079,15 +12317,17 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_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 -[**JsonApiAggregatedFactOutDocument**](JsonApiAggregatedFactOutDocument.md) +[**JsonApiWorkspaceColorPaletteOutList**](JsonApiWorkspaceColorPaletteOutList.md) ### Authorization @@ -12107,10 +12347,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_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) +# **get_all_entities_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutList get_all_entities_workspace_data_filter_settings(workspace_id) -Get a Dashboard +Get all Settings for Workspace Data Filters ### Example @@ -12119,7 +12359,7 @@ Get a Dashboard import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_list import JsonApiWorkspaceDataFilterSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12133,32 +12373,37 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "workspaceDataFilter", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + 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=permissions,origin,accessInfo,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) + # Get all Settings for Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_analytical_dashboards: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Dashboard - api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Settings for Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filter_settings(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_analytical_dashboards: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filter_settings: %s\n" % e) ``` @@ -12167,15 +12412,18 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_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 -[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) +[**JsonApiWorkspaceDataFilterSettingOutList**](JsonApiWorkspaceDataFilterSettingOutList.md) ### Authorization @@ -12195,10 +12443,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_api_tokens** -> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) - -Get an API Token for a user +# **get_all_entities_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutList get_all_entities_workspace_data_filters(workspace_id) + +Get all Workspace Data Filters ### Example @@ -12207,7 +12455,7 @@ Get an API Token for a user import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument +from gooddata_api_client.model.json_api_workspace_data_filter_out_list import JsonApiWorkspaceDataFilterOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12220,26 +12468,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) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - filter = "bearerToken==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) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "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 an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id) + # Get all Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_api_tokens: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an API Token for a user - api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) + # Get all Workspace Data Filters + api_response = api_instance.get_all_entities_workspace_data_filters(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_api_tokens: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_data_filters: %s\n" % e) ``` @@ -12247,13 +12507,19 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **id** | **str**| | + **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 -[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md) +[**JsonApiWorkspaceDataFilterOutList**](JsonApiWorkspaceDataFilterOutList.md) ### Authorization @@ -12273,10 +12539,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_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) +# **get_all_entities_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutList get_all_entities_workspace_export_templates(workspace_id) -Get an Attribute Hierarchy +Get all Workspace Export Templates ### Example @@ -12285,7 +12551,7 @@ Get an Attribute Hierarchy import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.model.json_api_workspace_export_template_out_list import JsonApiWorkspaceExportTemplateOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12299,32 +12565,34 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an Attribute Hierarchy - api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Workspace Export Templates + api_response = api_instance.get_all_entities_workspace_export_templates(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_export_templates: %s\n" % e) ``` @@ -12333,15 +12601,17 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_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 -[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) +[**JsonApiWorkspaceExportTemplateOutList**](JsonApiWorkspaceExportTemplateOutList.md) ### Authorization @@ -12361,10 +12631,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_attributes** -> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) +# **get_all_entities_workspace_settings** +> JsonApiWorkspaceSettingOutList get_all_entities_workspace_settings(workspace_id) -Get an Attribute +Get all Setting for Workspaces ### Example @@ -12373,7 +12643,7 @@ Get an Attribute import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.model.json_api_workspace_setting_out_list import JsonApiWorkspaceSettingOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12387,32 +12657,34 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id) + # Get all Setting for Workspaces + api_response = api_instance.get_all_entities_workspace_settings(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_attributes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an Attribute - api_response = api_instance.get_entity_attributes(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Setting for Workspaces + api_response = api_instance.get_all_entities_workspace_settings(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_attributes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_settings: %s\n" % e) ``` @@ -12421,15 +12693,17 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_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 -[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) +[**JsonApiWorkspaceSettingOutList**](JsonApiWorkspaceSettingOutList.md) ### Authorization @@ -12449,10 +12723,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_automations** -> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) +# **get_all_entities_workspace_themes** +> JsonApiWorkspaceThemeOutList get_all_entities_workspace_themes(workspace_id) -Get an Automation +Get all Workspace Themes ### Example @@ -12461,7 +12735,7 @@ Get an Automation import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.model.json_api_workspace_theme_out_list import JsonApiWorkspaceThemeOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12475,32 +12749,34 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id) + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_automations: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_themes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an Automation - api_response = api_instance.get_entity_automations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Workspace Themes + api_response = api_instance.get_all_entities_workspace_themes(workspace_id, origin=origin, filter=filter, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_automations: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspace_themes: %s\n" % e) ``` @@ -12509,15 +12785,17 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **object_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 -[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) +[**JsonApiWorkspaceThemeOutList**](JsonApiWorkspaceThemeOutList.md) ### Authorization @@ -12537,10 +12815,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_entity_color_palettes** -> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) +# **get_all_entities_workspaces** +> JsonApiWorkspaceOutList get_all_entities_workspaces() -Get Color Pallette +Get Workspace entities + +Space of the shared interest ### Example @@ -12549,7 +12829,7 @@ Get Color Pallette import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.model.json_api_workspace_out_list import JsonApiWorkspaceOutList from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12562,25 +12842,27 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_color_palettes: %s\n" % e) + filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "parent", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set # and optional values try: - # Get Color Pallette - api_response = api_instance.get_entity_color_palettes(id, filter=filter) + # Get Workspace entities + api_response = api_instance.get_all_entities_workspaces(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_entities_workspaces: %s\n" % e) ``` @@ -12588,12 +12870,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) +[**JsonApiWorkspaceOutList**](JsonApiWorkspaceOutList.md) ### Authorization @@ -12613,10 +12899,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_entity_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) +# **get_all_options** +> {str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_all_options() -Get CookieSecurityConfiguration +Links for all configuration options + +Retrieves links for all options for different configurations. ### Example @@ -12625,7 +12913,6 @@ Get CookieSecurityConfiguration import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument 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. @@ -12638,38 +12925,23 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_cookie_security_configurations: %s\n" % e) - # example passing only required values which don't have defaults set - # and optional values + # example, this endpoint has no required or optional parameters try: - # Get CookieSecurityConfiguration - api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) + # Links for all configuration options + api_response = api_instance.get_all_options() pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_cookie_security_configurations: %s\n" % e) + print("Exception when calling EntitiesApi->get_all_options: %s\n" % e) ``` ### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] +This endpoint does not need any parameter. ### Return type -[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) +**{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** ### Authorization @@ -12678,23 +12950,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**200** | Links for all configuration options. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_csp_directives** -> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id) +# **get_data_source_drivers** +> {str: (str,)} get_data_source_drivers() -Get CSP Directives +Get all available data source drivers - Context Security Police Directive +Retrieves a list of all supported data sources along with information about the used drivers. ### Example @@ -12703,7 +12975,6 @@ Get CSP Directives import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument 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. @@ -12716,38 +12987,23 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - - # example passing only required values which don't have defaults set - try: - # Get CSP Directives - api_response = api_instance.get_entity_csp_directives(id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_csp_directives: %s\n" % e) - # example passing only required values which don't have defaults set - # and optional values + # example, this endpoint has no required or optional parameters try: - # Get CSP Directives - api_response = api_instance.get_entity_csp_directives(id, filter=filter) + # Get all available data source drivers + api_response = api_instance.get_data_source_drivers() pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_csp_directives: %s\n" % e) + print("Exception when calling EntitiesApi->get_data_source_drivers: %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] +This endpoint does not need any parameter. ### Return type -[**JsonApiCspDirectiveOutDocument**](JsonApiCspDirectiveOutDocument.md) +**{str: (str,)}** ### Authorization @@ -12756,21 +13012,23 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**200** | A list of all available data source drivers. | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) +# **get_entity** +> get_entity(id) -Get a Custom Application Setting +Get LLM endpoint entity (Removed) + +Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. ### Example @@ -12779,7 +13037,6 @@ Get a Custom Application Setting import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument 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. @@ -12792,30 +13049,14 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "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) - 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 Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_application_settings: %s\n" % e) + id = "id_example" # str | # example passing only required values which don't have defaults set - # and optional values try: - # Get a Custom Application Setting - api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) - pprint(api_response) + # Get LLM endpoint entity (Removed) + api_instance.get_entity(id) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity: %s\n" % e) ``` @@ -12823,15 +13064,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] + **id** | **str**| | ### Return type -[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) +void (empty response body) ### Authorization @@ -12840,21 +13077,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/json, application/vnd.gooddata.api+json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Request successfully processed | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_custom_geo_collections** -> JsonApiCustomGeoCollectionOutDocument get_entity_custom_geo_collections(id) +# **get_entity_agents** +> JsonApiAgentOutDocument get_entity_agents(id) -Get Custom Geo Collection +Get Agent entity ### Example @@ -12863,7 +13100,7 @@ Get Custom Geo Collection import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12877,24 +13114,27 @@ 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;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Get Custom Geo Collection - api_response = api_instance.get_entity_custom_geo_collections(id) + # Get Agent entity + api_response = api_instance.get_entity_agents(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_geo_collections: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Custom Geo Collection - api_response = api_instance.get_entity_custom_geo_collections(id, filter=filter) + # Get Agent entity + api_response = api_instance.get_entity_agents(id, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_geo_collections: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_agents: %s\n" % e) ``` @@ -12904,10 +13144,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) +[**JsonApiAgentOutDocument**](JsonApiAgentOutDocument.md) ### Authorization @@ -12927,10 +13168,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_custom_user_application_settings** -> JsonApiCustomUserApplicationSettingOutDocument get_entity_custom_user_application_settings(user_id, id) +# **get_entity_aggregated_facts** +> JsonApiAggregatedFactOutDocument get_entity_aggregated_facts(workspace_id, object_id) -Get a custom application setting for a user +Get an Aggregated Fact ### Example @@ -12939,7 +13180,7 @@ Get a custom application setting for a 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_aggregated_fact_out_document import JsonApiAggregatedFactOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -12952,26 +13193,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) - user_id = "userId_example" # str | - id = "/6bUUGjjNSwg0_bs" # str | - 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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,sourceFact,sourceAttribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a custom application setting for a user - api_response = api_instance.get_entity_custom_user_application_settings(user_id, id) + # Get an Aggregated Fact + api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a custom application setting for a user - api_response = api_instance.get_entity_custom_user_application_settings(user_id, id, filter=filter) + # Get an Aggregated Fact + api_response = api_instance.get_entity_aggregated_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_custom_user_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_aggregated_facts: %s\n" % e) ``` @@ -12979,13 +13227,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **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 -[**JsonApiCustomUserApplicationSettingOutDocument**](JsonApiCustomUserApplicationSettingOutDocument.md) +[**JsonApiAggregatedFactOutDocument**](JsonApiAggregatedFactOutDocument.md) ### Authorization @@ -13005,10 +13256,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_dashboard_plugins** -> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) +# **get_entity_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument get_entity_analytical_dashboards(workspace_id, object_id) -Get a Plugin +Get a Dashboard ### Example @@ -13017,7 +13268,7 @@ Get 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_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13034,29 +13285,29 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,accessInfo,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) + # Get a Dashboard + api_response = api_instance.get_entity_analytical_dashboards(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_analytical_dashboards: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Plugin - api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Dashboard + api_response = api_instance.get_entity_analytical_dashboards(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_dashboard_plugins: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_analytical_dashboards: %s\n" % e) ``` @@ -13073,7 +13324,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) +[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) ### Authorization @@ -13093,10 +13344,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_data_source_identifiers** -> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id) +# **get_entity_api_tokens** +> JsonApiApiTokenOutDocument get_entity_api_tokens(user_id, id) -Get Data Source Identifier +Get an API Token for a user ### Example @@ -13105,7 +13356,7 @@ Get Data Source Identifier import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument +from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument 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. @@ -13118,28 +13369,26 @@ 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 | - filter = "name==someString;schema==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) - meta_include = [ - "metaInclude=permissions,all", - ] # [str] | Include Meta objects. (optional) + filter = "bearerToken==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) # example passing only required values which don't have defaults set try: - # Get Data Source Identifier - api_response = api_instance.get_entity_data_source_identifiers(id) + # Get an API Token for a user + api_response = api_instance.get_entity_api_tokens(user_id, id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_data_source_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_api_tokens: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Data Source Identifier - api_response = api_instance.get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) + # Get an API Token for a user + api_response = api_instance.get_entity_api_tokens(user_id, id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_data_source_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_api_tokens: %s\n" % e) ``` @@ -13147,13 +13396,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | **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] - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiDataSourceIdentifierOutDocument**](JsonApiDataSourceIdentifierOutDocument.md) +[**JsonApiApiTokenOutDocument**](JsonApiApiTokenOutDocument.md) ### Authorization @@ -13173,12 +13422,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_data_sources** -> JsonApiDataSourceOutDocument get_entity_data_sources(id) - -Get Data Source entity +# **get_entity_attribute_hierarchies** +> JsonApiAttributeHierarchyOutDocument get_entity_attribute_hierarchies(workspace_id, object_id) -Data Source - represents data source for the workspace +Get an Attribute Hierarchy ### Example @@ -13187,7 +13434,7 @@ 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_out_document import JsonApiDataSourceOutDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument 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. @@ -13200,28 +13447,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;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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Data Source entity - api_response = api_instance.get_entity_data_sources(id) + # Get an Attribute Hierarchy + api_response = api_instance.get_entity_attribute_hierarchies(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_attribute_hierarchies: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Data Source entity - api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) + # Get an Attribute Hierarchy + api_response = api_instance.get_entity_attribute_hierarchies(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_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_attribute_hierarchies: %s\n" % e) ``` @@ -13229,13 +13481,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 -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) +[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) ### Authorization @@ -13255,10 +13510,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_datasets** -> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) +# **get_entity_attributes** +> JsonApiAttributeOutDocument get_entity_attributes(workspace_id, object_id) -Get a Dataset +Get an Attribute ### Example @@ -13267,7 +13522,7 @@ Get a Dataset 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_attribute_out_document import JsonApiAttributeOutDocument 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. @@ -13282,31 +13537,31 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;dataset.id==321;defaultView.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", + "dataset,defaultView,labels,attributeHierarchies", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id) + # Get an Attribute + api_response = api_instance.get_entity_attributes(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_attributes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Dataset - api_response = api_instance.get_entity_datasets(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get an Attribute + api_response = api_instance.get_entity_attributes(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_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_attributes: %s\n" % e) ``` @@ -13323,7 +13578,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) +[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) ### Authorization @@ -13343,12 +13598,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_entitlements** -> JsonApiEntitlementOutDocument get_entity_entitlements(id) - -Get Entitlement entity +# **get_entity_automations** +> JsonApiAutomationOutDocument get_entity_automations(workspace_id, object_id) -Space of the shared interest +Get an Automation ### Example @@ -13357,7 +13610,7 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument 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. @@ -13370,25 +13623,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 = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Entitlement entity - api_response = api_instance.get_entity_entitlements(id) + # Get an Automation + api_response = api_instance.get_entity_automations(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_entitlements: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_automations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Entitlement entity - api_response = api_instance.get_entity_entitlements(id, filter=filter) + # Get an Automation + api_response = api_instance.get_entity_automations(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_entitlements: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_automations: %s\n" % e) ``` @@ -13396,12 +13657,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 -[**JsonApiEntitlementOutDocument**](JsonApiEntitlementOutDocument.md) +[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) ### Authorization @@ -13421,10 +13686,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_export_definitions** -> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) +# **get_entity_color_palettes** +> JsonApiColorPaletteOutDocument get_entity_color_palettes(id) -Get an Export Definition +Get Color Pallette ### Example @@ -13433,7 +13698,7 @@ Get an Export Definition import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -13446,33 +13711,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "visualizationObject,analyticalDashboard,automation,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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) + # Get Color Pallette + api_response = api_instance.get_entity_color_palettes(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_color_palettes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an Export Definition - api_response = api_instance.get_entity_export_definitions(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get Color Pallette + api_response = api_instance.get_entity_color_palettes(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_color_palettes: %s\n" % e) ``` @@ -13480,16 +13737,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) +[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) ### Authorization @@ -13509,10 +13762,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_export_templates** -> JsonApiExportTemplateOutDocument get_entity_export_templates(id) +# **get_entity_computed_attributes** +> JsonApiComputedAttributeOutDocument get_entity_computed_attributes(workspace_id, object_id) -GET Export Template entity +Get a Computed Attribute ### Example @@ -13521,7 +13774,7 @@ GET Export Template entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument 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. @@ -13534,25 +13787,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;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id) + # Get a Computed Attribute + api_response = api_instance.get_entity_computed_attributes(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_computed_attributes: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # GET Export Template entity - api_response = api_instance.get_entity_export_templates(id, filter=filter) + # Get a Computed Attribute + api_response = api_instance.get_entity_computed_attributes(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_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_computed_attributes: %s\n" % e) ``` @@ -13560,12 +13821,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 -[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.md) ### Authorization @@ -13585,10 +13850,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_facts** -> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) +# **get_entity_cookie_security_configurations** +> JsonApiCookieSecurityConfigurationOutDocument get_entity_cookie_security_configurations(id) -Get a Fact +Get CookieSecurityConfiguration ### Example @@ -13597,7 +13862,7 @@ Get a Fact import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument 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. @@ -13610,33 +13875,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id) + # Get CookieSecurityConfiguration + api_response = api_instance.get_entity_cookie_security_configurations(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_cookie_security_configurations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Fact - api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get CookieSecurityConfiguration + api_response = api_instance.get_entity_cookie_security_configurations(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_facts: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_cookie_security_configurations: %s\n" % e) ``` @@ -13644,16 +13901,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) +[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) ### Authorization @@ -13673,10 +13926,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_entity_filter_contexts** -> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) +# **get_entity_csp_directives** +> JsonApiCspDirectiveOutDocument get_entity_csp_directives(id) -Get a Filter Context +Get CSP Directives + + Context Security Police Directive ### Example @@ -13685,7 +13940,7 @@ Get a Filter Context import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument 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. @@ -13698,33 +13953,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get a Filter Context - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) + # Get CSP Directives + api_response = api_instance.get_entity_csp_directives(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_csp_directives: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Filter Context - api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get CSP Directives + api_response = api_instance.get_entity_csp_directives(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_csp_directives: %s\n" % e) ``` @@ -13732,16 +13979,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) +[**JsonApiCspDirectiveOutDocument**](JsonApiCspDirectiveOutDocument.md) ### Authorization @@ -13761,10 +14004,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_filter_views** -> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) +# **get_entity_custom_application_settings** +> JsonApiCustomApplicationSettingOutDocument get_entity_custom_application_settings(workspace_id, object_id) -Get Filter view +Get a Custom Application Setting ### Example @@ -13773,7 +14016,7 @@ Get Filter view import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument 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. @@ -13788,28 +14031,28 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.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 = [ - "analyticalDashboard,user", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + filter = "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) 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 Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id) + # Get a Custom Application Setting + api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_filter_views: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_custom_application_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Filter view - api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) + # Get a Custom Application Setting + api_response = api_instance.get_entity_custom_application_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_filter_views: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_custom_application_settings: %s\n" % e) ``` @@ -13820,12 +14063,12 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) +[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) ### Authorization @@ -13845,10 +14088,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_fiscal_calendars** -> JsonApiFiscalCalendarOutDocument get_entity_fiscal_calendars(workspace_id, object_id) +# **get_entity_custom_geo_collections** +> JsonApiCustomGeoCollectionOutDocument get_entity_custom_geo_collections(id) -Get a Fiscal Calendar +Get Custom Geo Collection ### Example @@ -13857,7 +14100,7 @@ Get a Fiscal Calendar import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument 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. @@ -13870,27 +14113,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==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) # example passing only required values which don't have defaults set try: - # Get a Fiscal Calendar - api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id) + # Get Custom Geo Collection + api_response = api_instance.get_entity_custom_geo_collections(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_fiscal_calendars: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_custom_geo_collections: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Fiscal Calendar - api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations) + # Get Custom Geo Collection + api_response = api_instance.get_entity_custom_geo_collections(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_fiscal_calendars: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_custom_geo_collections: %s\n" % e) ``` @@ -13898,14 +14139,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiFiscalCalendarOutDocument**](JsonApiFiscalCalendarOutDocument.md) +[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) ### Authorization @@ -13925,10 +14164,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_identity_providers** -> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) +# **get_entity_custom_user_application_settings** +> JsonApiCustomUserApplicationSettingOutDocument get_entity_custom_user_application_settings(user_id, id) -Get Identity Provider +Get a custom application setting for a user ### Example @@ -13937,7 +14176,7 @@ Get Identity Provider import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_custom_user_application_setting_out_document import JsonApiCustomUserApplicationSettingOutDocument 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. @@ -13950,25 +14189,26 @@ 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 | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + 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: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id) + # Get a custom application setting for a user + api_response = api_instance.get_entity_custom_user_application_settings(user_id, id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_custom_user_application_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Identity Provider - api_response = api_instance.get_entity_identity_providers(id, filter=filter) + # Get a custom application setting for a user + api_response = api_instance.get_entity_custom_user_application_settings(user_id, id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_custom_user_application_settings: %s\n" % e) ``` @@ -13976,12 +14216,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- + **user_id** | **str**| | **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 -[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) +[**JsonApiCustomUserApplicationSettingOutDocument**](JsonApiCustomUserApplicationSettingOutDocument.md) ### Authorization @@ -14001,10 +14242,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_ip_allowlist_policies** -> JsonApiIpAllowlistPolicyOutDocument get_entity_ip_allowlist_policies(id) +# **get_entity_dashboard_plugins** +> JsonApiDashboardPluginOutDocument get_entity_dashboard_plugins(workspace_id, object_id) -Get IpAllowlistPolicy entity +Get a Plugin ### Example @@ -14013,7 +14254,7 @@ Get IpAllowlistPolicy entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_ip_allowlist_policy_out_document import JsonApiIpAllowlistPolicyOutDocument +from gooddata_api_client.model.json_api_dashboard_plugin_out_document import JsonApiDashboardPluginOutDocument 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. @@ -14026,28 +14267,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 = "allowedSources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "users,userGroups", + "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 IpAllowlistPolicy entity - api_response = api_instance.get_entity_ip_allowlist_policies(id) + # Get a Plugin + api_response = api_instance.get_entity_dashboard_plugins(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_ip_allowlist_policies: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_dashboard_plugins: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get IpAllowlistPolicy entity - api_response = api_instance.get_entity_ip_allowlist_policies(id, filter=filter, include=include) + # Get a Plugin + api_response = api_instance.get_entity_dashboard_plugins(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_ip_allowlist_policies: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_dashboard_plugins: %s\n" % e) ``` @@ -14055,13 +14301,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 -[**JsonApiIpAllowlistPolicyOutDocument**](JsonApiIpAllowlistPolicyOutDocument.md) +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) ### Authorization @@ -14081,12 +14330,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_jwks** -> JsonApiJwkOutDocument get_entity_jwks(id) - -Get Jwk +# **get_entity_data_source_identifiers** +> JsonApiDataSourceIdentifierOutDocument get_entity_data_source_identifiers(id) -Returns JSON web key - used to verify JSON web tokens (Jwts) +Get Data Source Identifier ### Example @@ -14095,7 +14342,7 @@ Returns JSON web key - used to verify JSON web tokens (Jwts) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.model.json_api_data_source_identifier_out_document import JsonApiDataSourceIdentifierOutDocument 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. @@ -14109,24 +14356,27 @@ 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==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==someString;schema==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) + meta_include = [ + "metaInclude=permissions,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id) + # Get Data Source Identifier + api_response = api_instance.get_entity_data_source_identifiers(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_data_source_identifiers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Jwk - api_response = api_instance.get_entity_jwks(id, filter=filter) + # Get Data Source Identifier + api_response = api_instance.get_entity_data_source_identifiers(id, filter=filter, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_data_source_identifiers: %s\n" % e) ``` @@ -14136,10 +14386,11 @@ 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] + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) +[**JsonApiDataSourceIdentifierOutDocument**](JsonApiDataSourceIdentifierOutDocument.md) ### Authorization @@ -14159,10 +14410,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_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) +# **get_entity_data_sources** +> JsonApiDataSourceOutDocument get_entity_data_sources(id) -Get a Knowledge Recommendation +Get Data Source entity + +Data Source - represents data source for the workspace ### Example @@ -14171,7 +14424,7 @@ Get a Knowledge Recommendation import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +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. @@ -14184,33 +14437,28 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "metric,analyticalDashboard", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + id = "/6bUUGjjNSwg0_bs" # str | + 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) meta_include = [ - "metaInclude=origin,all", + "metaInclude=permissions,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a Knowledge Recommendation - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) + # Get Data Source entity + api_response = api_instance.get_entity_data_sources(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_data_sources: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Knowledge Recommendation - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get Data Source entity + api_response = api_instance.get_entity_data_sources(id, filter=filter, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_data_sources: %s\n" % e) ``` @@ -14218,16 +14466,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) ### Authorization @@ -14247,10 +14492,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_labels** -> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) +# **get_entity_datasets** +> JsonApiDatasetOutDocument get_entity_datasets(workspace_id, object_id) -Get a Label +Get a Dataset ### Example @@ -14259,7 +14504,7 @@ Get a Label import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.model.json_api_dataset_out_document import JsonApiDatasetOutDocument 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. @@ -14274,9 +14519,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;attribute.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 = [ - "attribute", + "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) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -14285,20 +14530,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id) + # Get a Dataset + api_response = api_instance.get_entity_datasets(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_labels: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_datasets: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Label - api_response = api_instance.get_entity_labels(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Dataset + api_response = api_instance.get_entity_datasets(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_labels: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_datasets: %s\n" % e) ``` @@ -14315,7 +14560,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) +[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) ### Authorization @@ -14335,10 +14580,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_entity_llm_providers** -> JsonApiLlmProviderOutDocument get_entity_llm_providers(id) +# **get_entity_entitlements** +> JsonApiEntitlementOutDocument get_entity_entitlements(id) -Get LLM Provider entity +Get Entitlement entity + +Space of the shared interest ### Example @@ -14347,7 +14594,7 @@ Get LLM Provider entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument 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. @@ -14361,24 +14608,24 @@ 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;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "value==someString;expiry==LocalDateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 LLM Provider entity - api_response = api_instance.get_entity_llm_providers(id) + # Get Entitlement entity + api_response = api_instance.get_entity_entitlements(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_llm_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_entitlements: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get LLM Provider entity - api_response = api_instance.get_entity_llm_providers(id, filter=filter) + # Get Entitlement entity + api_response = api_instance.get_entity_entitlements(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_llm_providers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_entitlements: %s\n" % e) ``` @@ -14391,7 +14638,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.md) +[**JsonApiEntitlementOutDocument**](JsonApiEntitlementOutDocument.md) ### Authorization @@ -14411,10 +14658,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_memory_items** -> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) +# **get_entity_export_definitions** +> JsonApiExportDefinitionOutDocument get_entity_export_definitions(workspace_id, object_id) -Get a Memory Item +Get an Export Definition ### Example @@ -14423,7 +14670,7 @@ Get a Memory Item import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument 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. @@ -14438,9 +14685,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy", + "visualizationObject,analyticalDashboard,automation,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 = [ @@ -14449,20 +14696,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Memory Item - api_response = api_instance.get_entity_memory_items(workspace_id, object_id) + # Get an Export Definition + api_response = api_instance.get_entity_export_definitions(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_export_definitions: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Memory Item - api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get an Export Definition + api_response = api_instance.get_entity_export_definitions(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_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_export_definitions: %s\n" % e) ``` @@ -14479,7 +14726,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) ### Authorization @@ -14499,10 +14746,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_metrics** -> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) +# **get_entity_export_templates** +> JsonApiExportTemplateOutDocument get_entity_export_templates(id) -Get a Metric +GET Export Template entity ### Example @@ -14511,7 +14758,7 @@ Get a Metric import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14524,33 +14771,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id) - pprint(api_response) + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_metrics: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Metric - api_response = api_instance.get_entity_metrics(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # GET Export Template entity + api_response = api_instance.get_entity_export_templates(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_metrics: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_export_templates: %s\n" % e) ``` @@ -14558,16 +14797,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) ### Authorization @@ -14587,10 +14822,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_notification_channel_identifiers** -> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id) +# **get_entity_facts** +> JsonApiFactOutDocument get_entity_facts(workspace_id, object_id) -Get Notification Channel Identifier entity +Get a Fact ### Example @@ -14599,7 +14834,7 @@ Get Notification Channel Identifier entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument +from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument 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. @@ -14612,25 +14847,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;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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Notification Channel Identifier entity - api_response = api_instance.get_entity_notification_channel_identifiers(id) + # Get a Fact + api_response = api_instance.get_entity_facts(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_notification_channel_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_facts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Notification Channel Identifier entity - api_response = api_instance.get_entity_notification_channel_identifiers(id, filter=filter) + # Get a Fact + api_response = api_instance.get_entity_facts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_notification_channel_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_facts: %s\n" % e) ``` @@ -14638,12 +14881,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 -[**JsonApiNotificationChannelIdentifierOutDocument**](JsonApiNotificationChannelIdentifierOutDocument.md) +[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) ### Authorization @@ -14663,10 +14910,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_notification_channels** -> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id) +# **get_entity_filter_contexts** +> JsonApiFilterContextOutDocument get_entity_filter_contexts(workspace_id, object_id) -Get Notification Channel entity +Get a Filter Context ### Example @@ -14675,7 +14922,7 @@ Get Notification Channel entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument 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. @@ -14688,25 +14935,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;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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "attributes,datasets,labels,computedAttributes,metrics,facts", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Notification Channel entity - api_response = api_instance.get_entity_notification_channels(id) + # Get a Filter Context + api_response = api_instance.get_entity_filter_contexts(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_notification_channels: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_filter_contexts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Notification Channel entity - api_response = api_instance.get_entity_notification_channels(id, filter=filter) + # Get a Filter Context + api_response = api_instance.get_entity_filter_contexts(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_notification_channels: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_filter_contexts: %s\n" % e) ``` @@ -14714,12 +14969,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 -[**JsonApiNotificationChannelOutDocument**](JsonApiNotificationChannelOutDocument.md) +[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) ### Authorization @@ -14739,10 +14998,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_org_memory_items** -> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) +# **get_entity_filter_views** +> JsonApiFilterViewOutDocument get_entity_filter_views(workspace_id, object_id) -Get an organization Memory Item entity +Get Filter view ### Example @@ -14751,7 +15010,7 @@ Get an organization Memory Item entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument 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. @@ -14764,28 +15023,30 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - filter = "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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.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", + "analyticalDashboard,user", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 # example passing only required values which don't have defaults set try: - # Get an organization Memory Item entity - api_response = api_instance.get_entity_org_memory_items(id) + # Get Filter view + api_response = api_instance.get_entity_filter_views(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_org_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_filter_views: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an organization Memory Item entity - api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) + # Get Filter view + api_response = api_instance.get_entity_filter_views(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_org_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_filter_views: %s\n" % e) ``` @@ -14793,13 +15054,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) +[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) ### Authorization @@ -14819,10 +15082,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_organization_settings** -> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id) +# **get_entity_fiscal_calendars** +> JsonApiFiscalCalendarOutDocument get_entity_fiscal_calendars(workspace_id, object_id) -Get Organization Setting entity +Get a Fiscal Calendar ### Example @@ -14831,7 +15094,7 @@ Get Organization Setting entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.model.json_api_fiscal_calendar_out_document import JsonApiFiscalCalendarOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14844,25 +15107,27 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False # example passing only required values which don't have defaults set try: - # Get Organization Setting entity - api_response = api_instance.get_entity_organization_settings(id) + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_fiscal_calendars: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Organization Setting entity - api_response = api_instance.get_entity_organization_settings(id, filter=filter) + # Get a Fiscal Calendar + api_response = api_instance.get_entity_fiscal_calendars(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_fiscal_calendars: %s\n" % e) ``` @@ -14870,12 +15135,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type -[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.md) +[**JsonApiFiscalCalendarOutDocument**](JsonApiFiscalCalendarOutDocument.md) ### Authorization @@ -14895,10 +15162,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_identity_providers** +> JsonApiIdentityProviderOutDocument get_entity_identity_providers(id) -Get Organizations +Get Identity Provider ### Example @@ -14907,7 +15174,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_identity_provider_out_document import JsonApiIdentityProviderOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -14921,30 +15188,24 @@ 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) + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id) + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_identity_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Organizations - api_response = api_instance.get_entity_organizations(id, filter=filter, include=include, meta_include=meta_include) + # Get Identity Provider + api_response = api_instance.get_entity_identity_providers(id, filter=filter) 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_identity_providers: %s\n" % e) ``` @@ -14954,12 +15215,10 @@ 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 -[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) +[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) ### Authorization @@ -14979,10 +15238,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_parameters** -> JsonApiParameterOutDocument get_entity_parameters(workspace_id, object_id) +# **get_entity_ip_allowlist_policies** +> JsonApiIpAllowlistPolicyOutDocument get_entity_ip_allowlist_policies(id) -Get a Parameter +Get IpAllowlistPolicy entity ### Example @@ -14991,7 +15250,7 @@ Get a Parameter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_parameter_out_document import JsonApiParameterOutDocument +from gooddata_api_client.model.json_api_ip_allowlist_policy_out_document import JsonApiIpAllowlistPolicyOutDocument 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. @@ -15004,33 +15263,28 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "allowedSources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy", + "users,userGroups", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - 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 Parameter - api_response = api_instance.get_entity_parameters(workspace_id, object_id) + # Get IpAllowlistPolicy entity + api_response = api_instance.get_entity_ip_allowlist_policies(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_ip_allowlist_policies: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Parameter - api_response = api_instance.get_entity_parameters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get IpAllowlistPolicy entity + api_response = api_instance.get_entity_ip_allowlist_policies(id, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_ip_allowlist_policies: %s\n" % e) ``` @@ -15038,16 +15292,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiParameterOutDocument**](JsonApiParameterOutDocument.md) +[**JsonApiIpAllowlistPolicyOutDocument**](JsonApiIpAllowlistPolicyOutDocument.md) ### Authorization @@ -15067,10 +15318,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_entity_themes** -> JsonApiThemeOutDocument get_entity_themes(id) +# **get_entity_jwks** +> JsonApiJwkOutDocument get_entity_jwks(id) -Get Theming +Get Jwk + +Returns JSON web key - used to verify JSON web tokens (Jwts) ### Example @@ -15079,7 +15332,7 @@ Get Theming import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument 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. @@ -15093,24 +15346,24 @@ 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;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) + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Get Theming - api_response = api_instance.get_entity_themes(id) + # Get Jwk + api_response = api_instance.get_entity_jwks(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_jwks: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Theming - api_response = api_instance.get_entity_themes(id, filter=filter) + # Get Jwk + api_response = api_instance.get_entity_jwks(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_jwks: %s\n" % e) ``` @@ -15123,7 +15376,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) +[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) ### Authorization @@ -15143,10 +15396,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_user_data_filters** -> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) +# **get_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) -Get a User Data Filter +Get a Knowledge Recommendation ### Example @@ -15155,7 +15408,7 @@ Get a User Data Filter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15170,9 +15423,9 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -15181,20 +15434,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) + # Get a Knowledge Recommendation + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a User Data Filter - api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Knowledge Recommendation + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_knowledge_recommendations: %s\n" % e) ``` @@ -15211,7 +15464,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) ### Authorization @@ -15231,12 +15484,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_user_groups** -> JsonApiUserGroupOutDocument get_entity_user_groups(id) - -Get UserGroup entity +# **get_entity_labels** +> JsonApiLabelOutDocument get_entity_labels(workspace_id, object_id) -User Group - creates tree-like structure for categorizing users +Get a Label ### Example @@ -15245,7 +15496,7 @@ User Group - creates tree-like structure for categorizing users import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument +from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument 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. @@ -15258,28 +15509,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" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;attribute.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 = [ - "parents", + "attribute", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get UserGroup entity - api_response = api_instance.get_entity_user_groups(id) + # Get a Label + api_response = api_instance.get_entity_labels(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_groups: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_labels: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get UserGroup entity - api_response = api_instance.get_entity_user_groups(id, filter=filter, include=include) + # Get a Label + api_response = api_instance.get_entity_labels(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_user_groups: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_labels: %s\n" % e) ``` @@ -15287,13 +15543,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 -[**JsonApiUserGroupOutDocument**](JsonApiUserGroupOutDocument.md) +[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) ### Authorization @@ -15313,12 +15572,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_user_identifiers** -> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id) - -Get UserIdentifier entity +# **get_entity_llm_providers** +> JsonApiLlmProviderOutDocument get_entity_llm_providers(id) -UserIdentifier - represents basic information about entity interacting with platform +Get LLM Provider entity ### Example @@ -15327,7 +15584,7 @@ UserIdentifier - represents basic information about entity interacting with plat import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument 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. @@ -15341,24 +15598,24 @@ 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 = "firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "name==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) # example passing only required values which don't have defaults set try: - # Get UserIdentifier entity - api_response = api_instance.get_entity_user_identifiers(id) + # Get LLM Provider entity + api_response = api_instance.get_entity_llm_providers(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_llm_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get UserIdentifier entity - api_response = api_instance.get_entity_user_identifiers(id, filter=filter) + # Get LLM Provider entity + api_response = api_instance.get_entity_llm_providers(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_identifiers: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_llm_providers: %s\n" % e) ``` @@ -15371,7 +15628,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiUserIdentifierOutDocument**](JsonApiUserIdentifierOutDocument.md) +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.md) ### Authorization @@ -15391,10 +15648,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_user_settings** -> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) +# **get_entity_memory_items** +> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) -Get a setting for a user +Get a Memory Item ### Example @@ -15403,7 +15660,7 @@ Get a setting for a user import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15416,26 +15673,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) - user_id = "userId_example" # str | - 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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id) + # Get a Memory Item + api_response = api_instance.get_entity_memory_items(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a setting for a user - api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) + # Get a Memory Item + api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_user_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_memory_items: %s\n" % e) ``` @@ -15443,13 +15707,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **user_id** | **str**| | - **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 -[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) ### Authorization @@ -15469,12 +15736,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_users** -> JsonApiUserOutDocument get_entity_users(id) - -Get User entity +# **get_entity_metrics** +> JsonApiMetricOutDocument get_entity_metrics(workspace_id, object_id) -User - represents entity interacting with platform +Get a Metric ### Example @@ -15483,7 +15748,7 @@ User - represents entity interacting with platform import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument 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. @@ -15496,28 +15761,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 = "authenticationId==someString;firstname==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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "userGroups", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get User entity - api_response = api_instance.get_entity_users(id) + # Get a Metric + api_response = api_instance.get_entity_metrics(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_users: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_metrics: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get User entity - api_response = api_instance.get_entity_users(id, filter=filter, include=include) + # Get a Metric + api_response = api_instance.get_entity_metrics(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_users: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_metrics: %s\n" % e) ``` @@ -15525,13 +15795,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 -[**JsonApiUserOutDocument**](JsonApiUserOutDocument.md) +[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) ### Authorization @@ -15551,10 +15824,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_visualization_objects** -> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) +# **get_entity_notification_channel_identifiers** +> JsonApiNotificationChannelIdentifierOutDocument get_entity_notification_channel_identifiers(id) -Get a Visualization Object +Get Notification Channel Identifier entity ### Example @@ -15563,7 +15836,7 @@ Get a Visualization Object import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from gooddata_api_client.model.json_api_notification_channel_identifier_out_document import JsonApiNotificationChannelIdentifierOutDocument 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. @@ -15576,33 +15849,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - 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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==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) # example passing only required values which don't have defaults set try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) + # Get Notification Channel Identifier entity + api_response = api_instance.get_entity_notification_channel_identifiers(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_notification_channel_identifiers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Visualization Object - api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get Notification Channel Identifier entity + api_response = api_instance.get_entity_notification_channel_identifiers(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_visualization_objects: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_notification_channel_identifiers: %s\n" % e) ``` @@ -15610,16 +15875,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) +[**JsonApiNotificationChannelIdentifierOutDocument**](JsonApiNotificationChannelIdentifierOutDocument.md) ### Authorization @@ -15639,10 +15900,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_color_palettes** -> JsonApiWorkspaceColorPaletteOutDocument get_entity_workspace_color_palettes(workspace_id, object_id) +# **get_entity_notification_channels** +> JsonApiNotificationChannelOutDocument get_entity_notification_channels(id) -Get a Workspace Color Palette +Get Notification Channel entity ### Example @@ -15651,7 +15912,7 @@ Get a Workspace Color Palette import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument 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. @@ -15664,30 +15925,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==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) # example passing only required values which don't have defaults set try: - # Get a Workspace Color Palette - api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id) + # Get Notification Channel entity + api_response = api_instance.get_entity_notification_channels(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_notification_channels: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Workspace Color Palette - api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get Notification Channel entity + api_response = api_instance.get_entity_notification_channels(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_notification_channels: %s\n" % e) ``` @@ -15695,15 +15951,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) +[**JsonApiNotificationChannelOutDocument**](JsonApiNotificationChannelOutDocument.md) ### Authorization @@ -15723,10 +15976,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_data_filter_settings** -> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) +# **get_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) -Get a Setting for Workspace Data Filter +Get an organization Memory Item entity ### Example @@ -15735,7 +15988,7 @@ Get a Setting for Workspace Data Filter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -15748,33 +16001,28 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "workspaceDataFilter", + "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 Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_org_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Setting for Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_org_memory_items: %s\n" % e) ``` @@ -15782,16 +16030,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) ### Authorization @@ -15811,10 +16056,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_data_filters** -> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) +# **get_entity_organization_settings** +> JsonApiOrganizationSettingOutDocument get_entity_organization_settings(id) -Get a Workspace Data Filter +Get Organization Setting entity ### Example @@ -15823,7 +16068,7 @@ Get a Workspace Data Filter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument 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. @@ -15836,33 +16081,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "filterSettings", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - meta_include = [ - "metaInclude=origin,all", - ] # [str] | Include Meta objects. (optional) + 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) # example passing only required values which don't have defaults set try: - # Get a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) + # Get 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_workspace_data_filters: %s\n" % 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 a Workspace Data Filter - api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get 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_workspace_data_filters: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_organization_settings: %s\n" % e) ``` @@ -15870,16 +16107,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **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 -[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) +[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.md) ### Authorization @@ -15899,10 +16132,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_export_templates** -> JsonApiWorkspaceExportTemplateOutDocument get_entity_workspace_export_templates(workspace_id, object_id) +# **get_entity_organizations** +> JsonApiOrganizationOutDocument get_entity_organizations(id) -Get a Workspace Export Template +Get Organizations ### Example @@ -15911,7 +16144,7 @@ Get a Workspace Export Template import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from gooddata_api_client.model.json_api_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. @@ -15924,30 +16157,31 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + 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=origin,all", + "metaInclude=permissions,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get a Workspace Export Template - api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id) + # 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_workspace_export_templates: %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 a Workspace Export Template - api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # 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_workspace_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_organizations: %s\n" % e) ``` @@ -15955,15 +16189,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **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 -[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) +[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) ### Authorization @@ -15983,10 +16216,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_settings** -> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) +# **get_entity_parameters** +> JsonApiParameterOutDocument get_entity_parameters(workspace_id, object_id) -Get a Setting for Workspace +Get a Parameter ### Example @@ -15995,7 +16228,7 @@ Get a Setting for Workspace import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from gooddata_api_client.model.json_api_parameter_out_document import JsonApiParameterOutDocument 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. @@ -16010,7 +16243,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;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", @@ -16018,20 +16254,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) + # Get a Parameter + api_response = api_instance.get_entity_parameters(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_parameters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Setting for Workspace - api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Parameter + api_response = api_instance.get_entity_parameters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_parameters: %s\n" % e) ``` @@ -16042,12 +16278,13 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) +[**JsonApiParameterOutDocument**](JsonApiParameterOutDocument.md) ### Authorization @@ -16067,10 +16304,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspace_themes** -> JsonApiWorkspaceThemeOutDocument get_entity_workspace_themes(workspace_id, object_id) +# **get_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument get_entity_report_page_layouts(workspace_id, object_id) -Get a Workspace Theme +Get a Report Page Layout ### Example @@ -16079,7 +16316,7 @@ Get a Workspace Theme import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument 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. @@ -16094,7 +16331,10 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = entities_api.EntitiesApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ "metaInclude=origin,all", @@ -16102,20 +16342,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Workspace Theme - api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id) + # Get a Report Page Layout + api_response = api_instance.get_entity_report_page_layouts(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Workspace Theme - api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Report Page Layout + api_response = api_instance.get_entity_report_page_layouts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspace_themes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_report_page_layouts: %s\n" % e) ``` @@ -16126,12 +16366,13 @@ Name | Type | Description | Notes **workspace_id** | **str**| | **object_id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -16151,12 +16392,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_workspaces** -> JsonApiWorkspaceOutDocument get_entity_workspaces(id) - -Get Workspace entity +# **get_entity_report_templates** +> JsonApiReportTemplateOutDocument get_entity_report_templates(workspace_id, object_id) -Space of the shared interest +Get a Report Template ### Example @@ -16165,7 +16404,7 @@ Space of the shared interest import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -16178,31 +16417,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;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "parent", + "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=config,permissions,hierarchy,dataModelDatasets,all", + "metaInclude=origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id) + # Get a Report Template + api_response = api_instance.get_entity_report_templates(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get Workspace entity - api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + # Get a Report Template + api_response = api_instance.get_entity_report_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_workspaces: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_report_templates: %s\n" % e) ``` @@ -16210,14 +16451,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 -[**JsonApiWorkspaceOutDocument**](JsonApiWorkspaceOutDocument.md) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -16237,12 +16480,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_organization** -> get_organization() - -Get current organization info +# **get_entity_reports** +> JsonApiReportOutDocument get_entity_reports(workspace_id, object_id) -Gets a basic information about organization. +Get a Report ### Example @@ -16251,6 +16492,7 @@ Gets a basic information about organization. import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument 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. @@ -16263,17 +16505,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) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=permissions", - ] # [str] | Return list of permissions available to logged user. (optional) + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Report + api_response = api_instance.get_entity_reports(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get current organization info - api_instance.get_organization(meta_include=meta_include) + # Get a Report + api_response = api_instance.get_entity_reports(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_organization: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_reports: %s\n" % e) ``` @@ -16281,11 +16539,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **meta_include** | **[str]**| Return list of permissions available to logged user. | [optional] + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] ### Return type -void (empty response body) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization @@ -16294,23 +16557,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**302** | Redirect to entity URI. | - | +**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** -> patch_entity(id) - -Patch LLM endpoint entity (Removed) +# **get_entity_themes** +> JsonApiThemeOutDocument get_entity_themes(id) -Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. +Get Theming ### Example @@ -16319,6 +16580,7 @@ Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 4 import time import gooddata_api_client from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -16331,14 +16593,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "id_example" # str | + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch LLM endpoint entity (Removed) - api_instance.patch_entity(id) + # Get Theming + api_response = api_instance.get_entity_themes(id) + pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Theming + api_response = api_instance.get_entity_themes(id, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_themes: %s\n" % e) ``` @@ -16347,10 +16620,11 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -void (empty response body) +[**JsonApiThemeOutDocument**](JsonApiThemeOutDocument.md) ### Authorization @@ -16359,21 +16633,21 @@ No authorization required ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**410** | Gone | - | +**200** | Request successfully processed | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **patch_entity_agents** -> JsonApiAgentOutDocument patch_entity_agents(id, json_api_agent_patch_document) +# **get_entity_user_data_filters** +> JsonApiUserDataFilterOutDocument get_entity_user_data_filters(workspace_id, object_id) -Patch Agent entity +Get a User Data Filter ### Example @@ -16382,8 +16656,7 @@ Patch Agent entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_agent_patch_document import JsonApiAgentPatchDocument -from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument +from gooddata_api_client.model.json_api_user_data_filter_out_document import JsonApiUserDataFilterOutDocument 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. @@ -16396,57 +16669,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 | - json_api_agent_patch_document = JsonApiAgentPatchDocument( - data=JsonApiAgentPatch( - attributes=JsonApiAgentInAttributes( - ai_knowledge=True, - available_to_all=True, - custom_skills=[ - "alert", - ], - description="description_example", - enabled=True, - is_preview=True, - name="name_example", - personality="personality_example", - skills_mode="all", - ), - id="id1", - relationships=JsonApiAgentInRelationships( - user_groups=JsonApiAgentInRelationshipsUserGroups( - data=JsonApiUserGroupToManyLinkage([ - JsonApiUserGroupLinkage( - id="id_example", - type="userGroup", - ), - ]), - ), - ), - type="agent", - ), - ) # JsonApiAgentPatchDocument | - filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;user.id==321;userGroup.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,userGroups", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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: - # Patch Agent entity - api_response = api_instance.patch_entity_agents(id, json_api_agent_patch_document) + # Get a User Data Filter + api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_agents: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_data_filters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Agent entity - api_response = api_instance.patch_entity_agents(id, json_api_agent_patch_document, filter=filter, include=include) + # Get a User Data Filter + api_response = api_instance.get_entity_user_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_agents: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_data_filters: %s\n" % e) ``` @@ -16454,14 +16703,16 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_agent_patch_document** | [**JsonApiAgentPatchDocument**](JsonApiAgentPatchDocument.md)| | + **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 -[**JsonApiAgentOutDocument**](JsonApiAgentOutDocument.md) +[**JsonApiUserDataFilterOutDocument**](JsonApiUserDataFilterOutDocument.md) ### Authorization @@ -16469,7 +16720,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -16481,10 +16732,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) -# **patch_entity_analytical_dashboards** -> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) +# **get_entity_user_groups** +> JsonApiUserGroupOutDocument get_entity_user_groups(id) -Patch a Dashboard +Get UserGroup entity + +User Group - creates tree-like structure for categorizing users ### Example @@ -16493,8 +16746,7 @@ Patch a Dashboard import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument -from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from gooddata_api_client.model.json_api_user_group_out_document import JsonApiUserGroupOutDocument 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. @@ -16507,45 +16759,28 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( - data=JsonApiAnalyticalDashboardPatch( - attributes=JsonApiAnalyticalDashboardPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - summary="summary_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="analyticalDashboard", - ), - ) # JsonApiAnalyticalDashboardPatchDocument | - 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) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==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,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "parents", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) + # Get UserGroup entity + api_response = api_instance.get_entity_user_groups(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_analytical_dashboards: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_groups: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Dashboard - api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) + # Get UserGroup entity + api_response = api_instance.get_entity_user_groups(id, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_analytical_dashboards: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_groups: %s\n" % e) ``` @@ -16553,15 +16788,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.md)| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.md) +[**JsonApiUserGroupOutDocument**](JsonApiUserGroupOutDocument.md) ### Authorization @@ -16569,7 +16802,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -16581,10 +16814,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) -# **patch_entity_attribute_hierarchies** -> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) +# **get_entity_user_identifiers** +> JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id) -Patch an Attribute Hierarchy +Get UserIdentifier entity + +UserIdentifier - represents basic information about entity interacting with platform ### Example @@ -16593,8 +16828,7 @@ Patch an Attribute Hierarchy import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument -from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument 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. @@ -16607,44 +16841,25 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( - data=JsonApiAttributeHierarchyPatch( - attributes=JsonApiAttributeHierarchyInAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - type="attributeHierarchy", - ), - ) # JsonApiAttributeHierarchyPatchDocument | - 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,attributes", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "firstname==someString;lastname==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) # example passing only required values which don't have defaults set try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) + # Get UserIdentifier entity + api_response = api_instance.get_entity_user_identifiers(id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_identifiers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch an Attribute Hierarchy - api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) + # Get UserIdentifier entity + api_response = api_instance.get_entity_user_identifiers(id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_attribute_hierarchies: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_identifiers: %s\n" % e) ``` @@ -16652,15 +16867,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.md)| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.md) +[**JsonApiUserIdentifierOutDocument**](JsonApiUserIdentifierOutDocument.md) ### Authorization @@ -16668,7 +16880,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -16680,10 +16892,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_attributes** -> JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) +# **get_entity_user_settings** +> JsonApiUserSettingOutDocument get_entity_user_settings(user_id, id) -Patch an Attribute (beta) +Get a setting for a user ### Example @@ -16692,8 +16904,7 @@ Patch an Attribute (beta) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument -from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument 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. @@ -16706,47 +16917,26 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_attribute_patch_document = JsonApiAttributePatchDocument( - data=JsonApiAttributePatch( - attributes=JsonApiAttributePatchAttributes( - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", - ), - id="id1", - relationships=JsonApiAttributePatchRelationships( - default_view=JsonApiAttributeOutRelationshipsDefaultView( - data=JsonApiLabelToOneLinkage(None), - ), - ), - type="attribute", - ), - ) # JsonApiAttributePatchDocument | - filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset,defaultView,labels,attributeHierarchies", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + user_id = "userId_example" # str | + 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) # example passing only required values which don't have defaults set try: - # Patch an Attribute (beta) - api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) + # Get a setting for a user + api_response = api_instance.get_entity_user_settings(user_id, id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_attributes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch an Attribute (beta) - api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) + # Get a setting for a user + api_response = api_instance.get_entity_user_settings(user_id, id, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_attributes: %s\n" % e) + print("Exception when calling EntitiesApi->get_entity_user_settings: %s\n" % e) ``` @@ -16754,15 +16944,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_attribute_patch_document** | [**JsonApiAttributePatchDocument**](JsonApiAttributePatchDocument.md)| | + **user_id** | **str**| | + **id** | **str**| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] - **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.md) +[**JsonApiUserSettingOutDocument**](JsonApiUserSettingOutDocument.md) ### Authorization @@ -16770,7 +16958,7 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.gooddata.api+json @@ -16782,10 +16970,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) -# **patch_entity_automations** -> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) +# **get_entity_users** +> JsonApiUserOutDocument get_entity_users(id) -Patch an Automation +Get User entity + +User - represents entity interacting with platform ### Example @@ -16794,8 +16984,7 @@ Patch an Automation import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument -from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +from gooddata_api_client.model.json_api_user_out_document import JsonApiUserOutDocument 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. @@ -16808,19 +16997,1354 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_automation_patch_document = JsonApiAutomationPatchDocument( - data=JsonApiAutomationPatch( - attributes=JsonApiAutomationInAttributes( - alert=JsonApiAutomationInAttributesAlert( - condition=AlertCondition(), - execution=AlertAfm( - attributes=[ - AttributeItem( - label=AfmObjectIdentifierLabel( - identifier=AfmObjectIdentifierLabelIdentifier( - id="sample_item.price", + id = "/6bUUGjjNSwg0_bs" # str | + filter = "authenticationId==someString;firstname==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 = [ + "userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Get User entity + api_response = api_instance.get_entity_users(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_users: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get User entity + api_response = api_instance.get_entity_users(id, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_users: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiUserOutDocument**](JsonApiUserOutDocument.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_visualization_objects** +> JsonApiVisualizationObjectOutDocument get_entity_visualization_objects(workspace_id, object_id) + +Get a Visualization Object + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_visualization_object_out_document import JsonApiVisualizationObjectOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=permissions,origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Visualization Object + api_response = api_instance.get_entity_visualization_objects(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_visualization_objects: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Visualization Object + api_response = api_instance.get_entity_visualization_objects(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_visualization_objects: %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 + +[**JsonApiVisualizationObjectOutDocument**](JsonApiVisualizationObjectOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_color_palettes** +> JsonApiWorkspaceColorPaletteOutDocument get_entity_workspace_color_palettes(workspace_id, object_id) + +Get a Workspace Color Palette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_color_palette_out_document import JsonApiWorkspaceColorPaletteOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Color Palette + api_response = api_instance.get_entity_workspace_color_palettes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceColorPaletteOutDocument**](JsonApiWorkspaceColorPaletteOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_data_filter_settings** +> JsonApiWorkspaceDataFilterSettingOutDocument get_entity_workspace_data_filter_settings(workspace_id, object_id) + +Get a Setting for Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_document import JsonApiWorkspaceDataFilterSettingOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;workspaceDataFilter.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "workspaceDataFilter", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Setting for Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Setting for Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filter_settings(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_data_filter_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceDataFilterSettingOutDocument**](JsonApiWorkspaceDataFilterSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_data_filters** +> JsonApiWorkspaceDataFilterOutDocument get_entity_workspace_data_filters(workspace_id, object_id) + +Get a Workspace Data Filter + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_data_filter_out_document import JsonApiWorkspaceDataFilterOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "filterSettings", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Data Filter + api_response = api_instance.get_entity_workspace_data_filters(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_data_filters: %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 + +[**JsonApiWorkspaceDataFilterOutDocument**](JsonApiWorkspaceDataFilterOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_export_templates** +> JsonApiWorkspaceExportTemplateOutDocument get_entity_workspace_export_templates(workspace_id, object_id) + +Get a Workspace Export Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_export_template_out_document import JsonApiWorkspaceExportTemplateOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;dashboardSlidesTemplate==WorkspaceDashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_export_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Export Template + api_response = api_instance.get_entity_workspace_export_templates(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_export_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceExportTemplateOutDocument**](JsonApiWorkspaceExportTemplateOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_settings** +> JsonApiWorkspaceSettingOutDocument get_entity_workspace_settings(workspace_id, object_id) + +Get a Setting for Workspace + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_setting_out_document import JsonApiWorkspaceSettingOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Setting for Workspace + api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Setting for Workspace + api_response = api_instance.get_entity_workspace_settings(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_settings: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceSettingOutDocument**](JsonApiWorkspaceSettingOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspace_themes** +> JsonApiWorkspaceThemeOutDocument get_entity_workspace_themes(workspace_id, object_id) + +Get a Workspace Theme + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_theme_out_document import JsonApiWorkspaceThemeOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_themes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Workspace Theme + api_response = api_instance.get_entity_workspace_themes(workspace_id, object_id, filter=filter, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspace_themes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceThemeOutDocument**](JsonApiWorkspaceThemeOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_workspaces** +> JsonApiWorkspaceOutDocument get_entity_workspaces(id) + +Get Workspace entity + +Space of the shared interest + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_workspace_out_document import JsonApiWorkspaceOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "name==someString;earlyAccess==someString;parent.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "parent", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get Workspace entity + api_response = api_instance.get_entity_workspaces(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get Workspace entity + api_response = api_instance.get_entity_workspaces(id, filter=filter, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_entity_workspaces: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiWorkspaceOutDocument**](JsonApiWorkspaceOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_organization** +> get_organization() + +Get current organization info + +Gets a basic information about organization. + +### Example + + +```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) + meta_include = [ + "metaInclude=permissions", + ] # [str] | Return list of permissions available to logged user. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get current organization info + api_instance.get_organization(meta_include=meta_include) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->get_organization: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **meta_include** | **[str]**| Return list of permissions available to logged user. | [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 | +|-------------|-------------|------------------| +**302** | Redirect to entity URI. | - | + +[[Back to top]](#) [[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** +> patch_entity(id) + +Patch LLM endpoint entity (Removed) + +Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. + +### 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 = "id_example" # str | + + # example passing only required values which don't have defaults set + try: + # Patch LLM endpoint entity (Removed) + api_instance.patch_entity(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**410** | Gone | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_agents** +> JsonApiAgentOutDocument patch_entity_agents(id, json_api_agent_patch_document) + +Patch Agent entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_agent_patch_document import JsonApiAgentPatchDocument +from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_agent_patch_document = JsonApiAgentPatchDocument( + data=JsonApiAgentPatch( + attributes=JsonApiAgentInAttributes( + ai_knowledge=True, + available_to_all=True, + custom_skills=[ + "alert", + ], + description="description_example", + enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], + is_preview=True, + name="name_example", + personality="personality_example", + skills_mode="all", + ), + id="id1", + relationships=JsonApiAgentInRelationships( + user_groups=JsonApiAgentInRelationshipsUserGroups( + data=JsonApiUserGroupToManyLinkage([ + JsonApiUserGroupLinkage( + id="id_example", + type="userGroup", + ), + ]), + ), + ), + type="agent", + ), + ) # JsonApiAgentPatchDocument | + filter = "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,userGroups", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Agent entity + api_response = api_instance.patch_entity_agents(id, json_api_agent_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_agents: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Agent entity + api_response = api_instance.patch_entity_agents(id, json_api_agent_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_agents: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_agent_patch_document** | [**JsonApiAgentPatchDocument**](JsonApiAgentPatchDocument.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 + +[**JsonApiAgentOutDocument**](JsonApiAgentOutDocument.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_analytical_dashboards** +> JsonApiAnalyticalDashboardOutDocument patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) + +Patch a Dashboard + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_analytical_dashboard_patch_document import JsonApiAnalyticalDashboardPatchDocument +from gooddata_api_client.model.json_api_analytical_dashboard_out_document import JsonApiAnalyticalDashboardOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_analytical_dashboard_patch_document = JsonApiAnalyticalDashboardPatchDocument( + data=JsonApiAnalyticalDashboardPatch( + attributes=JsonApiAnalyticalDashboardPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + summary="summary_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="analyticalDashboard", + ), + ) # JsonApiAnalyticalDashboardPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Dashboard + api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_analytical_dashboards: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Dashboard + api_response = api_instance.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_analytical_dashboards: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_analytical_dashboard_patch_document** | [**JsonApiAnalyticalDashboardPatchDocument**](JsonApiAnalyticalDashboardPatchDocument.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 + +[**JsonApiAnalyticalDashboardOutDocument**](JsonApiAnalyticalDashboardOutDocument.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_attribute_hierarchies** +> JsonApiAttributeHierarchyOutDocument patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) + +Patch an Attribute Hierarchy + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_attribute_hierarchy_patch_document import JsonApiAttributeHierarchyPatchDocument +from gooddata_api_client.model.json_api_attribute_hierarchy_out_document import JsonApiAttributeHierarchyOutDocument +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_attribute_hierarchy_patch_document = JsonApiAttributeHierarchyPatchDocument( + data=JsonApiAttributeHierarchyPatch( + attributes=JsonApiAttributeHierarchyInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="attributeHierarchy", + ), + ) # JsonApiAttributeHierarchyPatchDocument | + 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,attributes", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Attribute Hierarchy + api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_attribute_hierarchies: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Attribute Hierarchy + api_response = api_instance.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_attribute_hierarchies: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_hierarchy_patch_document** | [**JsonApiAttributeHierarchyPatchDocument**](JsonApiAttributeHierarchyPatchDocument.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 + +[**JsonApiAttributeHierarchyOutDocument**](JsonApiAttributeHierarchyOutDocument.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_attributes** +> JsonApiAttributeOutDocument patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) + +Patch an Attribute (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_attribute_patch_document import JsonApiAttributePatchDocument +from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument +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_attribute_patch_document = JsonApiAttributePatchDocument( + data=JsonApiAttributePatch( + attributes=JsonApiAttributePatchAttributes( + conditional_formatting=JsonApiAttributeOutAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiAttributePatchRelationships( + default_view=JsonApiAttributeOutRelationshipsDefaultView( + data=JsonApiLabelToOneLinkage(None), + ), + ), + type="attribute", + ), + ) # JsonApiAttributePatchDocument | + filter = "title==someString;description==someString;dataset.id==321;defaultView.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "dataset,defaultView,labels,attributeHierarchies", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Attribute (beta) + api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Attribute (beta) + api_response = api_instance.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_attribute_patch_document** | [**JsonApiAttributePatchDocument**](JsonApiAttributePatchDocument.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 + +[**JsonApiAttributeOutDocument**](JsonApiAttributeOutDocument.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_automations** +> JsonApiAutomationOutDocument patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) + +Patch an Automation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_automation_out_document import JsonApiAutomationOutDocument +from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument +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_automation_patch_document = JsonApiAutomationPatchDocument( + data=JsonApiAutomationPatch( + attributes=JsonApiAutomationInAttributes( + alert=JsonApiAutomationInAttributesAlert( + condition=AlertCondition(), + execution=AlertAfm( + attributes=[ + AttributeItem( + label=AfmObjectIdentifierLabel( + identifier=AfmObjectIdentifierLabelIdentifier( + id="sample_item.price", type="label", ), ), @@ -16848,6 +18372,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -16992,167 +18521,566 @@ with gooddata_api_client.ApiClient() as api_client: first_run=dateutil_parser('2025-01-01T12:00:00Z'), timezone="Europe/Prague", ), - slides_exports=[ - JsonApiAutomationInAttributesSlidesExportsInner( - request_payload=SlidesExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - format="PDF", - metadata=JsonNode(), - template_id="template_id_example", - timezone_id="Asia/Kolkata", - visualization_ids=[ - "visualization_ids_example", - ], - widget_ids=[ - "widget_ids_example", - ], - ), - ), - ], - state="ACTIVE", - tabular_exports=[ - JsonApiAutomationInAttributesTabularExportsInner( - request_payload=TabularExportRequest( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - execution_settings=ExecutionSettings( - data_sampling_percentage=0, - timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), - timezone="Europe/Prague", - ), - executions=[ - TabularExportExecution( - custom_override=CustomOverride( - labels={ - "key": CustomLabel( - title="title_example", - ), - }, - metrics={ - "key": CustomMetric( - format="format_example", - title="title_example", - ), - }, - ), - execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", - title="Pushpins", - ), - ], - file_name="result", - format="CSV", - metadata=JsonNode(), - related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - settings=Settings( - delimiter="-", - export_info=True, - grand_totals_position="pinnedBottom", - merge_headers=True, - page_orientation="PORTRAIT", - page_size="A4", - pdf_page_size="a4 landscape", - pdf_table_style=[ - PdfTableStyle( - properties=[ - PdfTableStyleProperty( - key="key_example", - value="value_example", - ), - ], - selector="selector_example", - ), - ], - pdf_top_left_content="Good", - pdf_top_right_content="Morning", - show_filters=False, - ), - visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", - visualization_object_custom_filters=[ - {}, - ], - visualization_object_custom_parameters=[ - ParameterValue(), - ], - ), - ), - ], + slides_exports=[ + JsonApiAutomationInAttributesSlidesExportsInner( + request_payload=SlidesExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + format="PDF", + metadata=JsonNode(), + template_id="template_id_example", + timezone_id="Asia/Kolkata", + visualization_ids=[ + "visualization_ids_example", + ], + widget_ids=[ + "widget_ids_example", + ], + ), + ), + ], + state="ACTIVE", + tabular_exports=[ + JsonApiAutomationInAttributesTabularExportsInner( + request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + execution_settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), + executions=[ + TabularExportExecution( + custom_override=CustomOverride( + labels={ + "key": CustomLabel( + title="title_example", + ), + }, + metrics={ + "key": CustomMetric( + format="format_example", + title="title_example", + ), + }, + ), + execution_result="ff483727196c9dc862c7fd3a5a84df55c96d61a4", + title="Pushpins", + ), + ], + file_name="result", + format="CSV", + metadata=JsonNode(), + related_dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + settings=Settings( + delimiter="-", + export_info=True, + grand_totals_position="pinnedBottom", + merge_headers=True, + page_orientation="PORTRAIT", + page_size="A4", + pdf_page_size="a4 landscape", + pdf_table_style=[ + PdfTableStyle( + properties=[ + PdfTableStyleProperty( + key="key_example", + value="value_example", + ), + ], + selector="selector_example", + ), + ], + pdf_top_left_content="Good", + pdf_top_right_content="Morning", + show_filters=False, + ), + visualization_object="f7c359bc-c230-4487-b15b-ad9685bcb537", + visualization_object_custom_filters=[ + {}, + ], + visualization_object_custom_parameters=[ + ParameterValue(), + ], + ), + ), + ], + tags=[ + "tags_example", + ], + title="title_example", + visual_exports=[ + JsonApiAutomationInAttributesVisualExportsInner( + request_payload=VisualExportRequest( + dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + file_name="filename", + metadata={}, + timezone_id="Asia/Kolkata", + ), + ), + ], + ), + id="id1", + relationships=JsonApiAutomationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( + data=JsonApiExportDefinitionToManyLinkage([ + JsonApiExportDefinitionLinkage( + id="id_example", + type="exportDefinition", + ), + ]), + ), + notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( + data=JsonApiNotificationChannelToOneLinkage(None), + ), + recipients=JsonApiAutomationInRelationshipsRecipients( + data=JsonApiUserToManyLinkage([ + JsonApiUserLinkage( + id="id_example", + type="user", + ), + ]), + ), + ), + type="automation", + ), + ) # JsonApiAutomationPatchDocument | + filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an Automation + api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_automations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an Automation + api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_automations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.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 + +[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.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_color_palettes** +> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) + +Patch Color Pallette + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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_color_palette_patch_document = JsonApiColorPalettePatchDocument( + data=JsonApiColorPalettePatch( + attributes=JsonApiColorPalettePatchAttributes( + content={}, + name="name_example", + ), + id="id1", + type="colorPalette", + ), + ) # JsonApiColorPalettePatchDocument | + filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + + # example passing only required values which don't have defaults set + try: + # Patch Color Pallette + api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_color_palettes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch Color Pallette + api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_color_palettes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + +### Return type + +[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.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_computed_attributes** +> JsonApiComputedAttributeOutDocument patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document) + +Patch a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +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_computed_attribute_patch_document = JsonApiComputedAttributePatchDocument( + data=JsonApiComputedAttributePatch( + attributes=JsonApiComputedAttributePatchAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", tags=[ "tags_example", ], title="title_example", - visual_exports=[ - JsonApiAutomationInAttributesVisualExportsInner( - request_payload=VisualExportRequest( - dashboard_id="761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - file_name="filename", - metadata={}, - timezone_id="Asia/Kolkata", - ), - ), + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributePatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Computed Attribute + api_response = api_instance.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Computed Attribute + api_response = api_instance.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_computed_attribute_patch_document** | [**JsonApiComputedAttributePatchDocument**](JsonApiComputedAttributePatchDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.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_cookie_security_configurations** +> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) + +Patch CookieSecurityConfiguration + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument +from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +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_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( + data=JsonApiCookieSecurityConfigurationPatch( + attributes=JsonApiCookieSecurityConfigurationInAttributes( + last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), + rotation_interval="P30D", + ), + id="id1", + type="cookieSecurityConfiguration", + ), + ) # JsonApiCookieSecurityConfigurationPatchDocument | + filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 CookieSecurityConfiguration + api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_cookie_security_configurations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch CookieSecurityConfiguration + api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->patch_entity_cookie_security_configurations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.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 + +[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.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_csp_directives** +> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document) + +Patch CSP Directives + + Context Security Police Directive + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument +from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +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_csp_directive_patch_document = JsonApiCspDirectivePatchDocument( + data=JsonApiCspDirectivePatch( + attributes=JsonApiCspDirectivePatchAttributes( + sources=[ + "sources_example", ], ), id="id1", - relationships=JsonApiAutomationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - export_definitions=JsonApiAutomationInRelationshipsExportDefinitions( - data=JsonApiExportDefinitionToManyLinkage([ - JsonApiExportDefinitionLinkage( - id="id_example", - type="exportDefinition", - ), - ]), - ), - notification_channel=JsonApiAutomationInRelationshipsNotificationChannel( - data=JsonApiNotificationChannelToOneLinkage(None), - ), - recipients=JsonApiAutomationInRelationshipsRecipients( - data=JsonApiUserToManyLinkage([ - JsonApiUserLinkage( - id="id_example", - type="user", - ), - ]), - ), - ), - type="automation", + type="cspDirective", ), - ) # JsonApiAutomationPatchDocument | - filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiCspDirectivePatchDocument | + filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document) + # Patch CSP Directives + api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_automations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_csp_directives: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch an Automation - api_response = api_instance.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, filter=filter, include=include) + # Patch CSP Directives + api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_automations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_csp_directives: %s\n" % e) ``` @@ -17160,15 +19088,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_automation_patch_document** | [**JsonApiAutomationPatchDocument**](JsonApiAutomationPatchDocument.md)| | + **id** | **str**| | + **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.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 -[**JsonApiAutomationOutDocument**](JsonApiAutomationOutDocument.md) +[**JsonApiCspDirectiveOutDocument**](JsonApiCspDirectiveOutDocument.md) ### Authorization @@ -17188,10 +19114,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **patch_entity_color_palettes** -> JsonApiColorPaletteOutDocument patch_entity_color_palettes(id, json_api_color_palette_patch_document) +# **patch_entity_custom_application_settings** +> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) -Patch Color Pallette +Patch a Custom Application Setting ### Example @@ -17200,8 +19126,8 @@ Patch Color Pallette import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument -from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument +from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument +from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument 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. @@ -17214,35 +19140,36 @@ 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_color_palette_patch_document = JsonApiColorPalettePatchDocument( - data=JsonApiColorPalettePatch( - attributes=JsonApiColorPalettePatchAttributes( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( + data=JsonApiCustomApplicationSettingPatch( + attributes=JsonApiCustomApplicationSettingPatchAttributes( + application_name="application_name_example", content={}, - name="name_example", ), id="id1", - type="colorPalette", + type="customApplicationSetting", ), - ) # JsonApiColorPalettePatchDocument | - filter = "name==someString;content==JsonNodeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiCustomApplicationSettingPatchDocument | + 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: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document) + # Patch a Custom Application Setting + api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_custom_application_settings: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Color Pallette - api_response = api_instance.patch_entity_color_palettes(id, json_api_color_palette_patch_document, filter=filter) + # Patch a Custom Application Setting + api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_color_palettes: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_custom_application_settings: %s\n" % e) ``` @@ -17250,13 +19177,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_color_palette_patch_document** | [**JsonApiColorPalettePatchDocument**](JsonApiColorPalettePatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) +[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) ### Authorization @@ -17276,10 +19204,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_cookie_security_configurations** -> JsonApiCookieSecurityConfigurationOutDocument patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) +# **patch_entity_custom_geo_collections** +> JsonApiCustomGeoCollectionOutDocument patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) -Patch CookieSecurityConfiguration +Patch Custom Geo Collection ### Example @@ -17288,8 +19216,8 @@ Patch CookieSecurityConfiguration import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument -from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument +from gooddata_api_client.model.json_api_custom_geo_collection_patch_document import JsonApiCustomGeoCollectionPatchDocument +from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument 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. @@ -17303,34 +19231,34 @@ 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_cookie_security_configuration_patch_document = JsonApiCookieSecurityConfigurationPatchDocument( - data=JsonApiCookieSecurityConfigurationPatch( - attributes=JsonApiCookieSecurityConfigurationInAttributes( - last_rotation=dateutil_parser('1970-01-01T00:00:00.00Z'), - rotation_interval="P30D", + json_api_custom_geo_collection_patch_document = JsonApiCustomGeoCollectionPatchDocument( + data=JsonApiCustomGeoCollectionPatch( + attributes=JsonApiCustomGeoCollectionInAttributes( + description="description_example", + name="name_example", ), id="id1", - type="cookieSecurityConfiguration", + type="customGeoCollection", ), - ) # JsonApiCookieSecurityConfigurationPatchDocument | - filter = "lastRotation==InstantValue;rotationInterval==DurationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiCustomGeoCollectionPatchDocument | + filter = "name==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) # example passing only required values which don't have defaults set try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document) + # Patch Custom Geo Collection + api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_cookie_security_configurations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_custom_geo_collections: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch CookieSecurityConfiguration - api_response = api_instance.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, filter=filter) + # Patch Custom Geo Collection + api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_cookie_security_configurations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_custom_geo_collections: %s\n" % e) ``` @@ -17339,12 +19267,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_cookie_security_configuration_patch_document** | [**JsonApiCookieSecurityConfigurationPatchDocument**](JsonApiCookieSecurityConfigurationPatchDocument.md)| | + **json_api_custom_geo_collection_patch_document** | [**JsonApiCustomGeoCollectionPatchDocument**](JsonApiCustomGeoCollectionPatchDocument.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 -[**JsonApiCookieSecurityConfigurationOutDocument**](JsonApiCookieSecurityConfigurationOutDocument.md) +[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) ### Authorization @@ -17364,12 +19292,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_csp_directives** -> JsonApiCspDirectiveOutDocument patch_entity_csp_directives(id, json_api_csp_directive_patch_document) - -Patch CSP Directives +# **patch_entity_dashboard_plugins** +> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) - Context Security Police Directive +Patch a Plugin ### Example @@ -17378,8 +19304,8 @@ Patch CSP Directives import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_csp_directive_out_document import JsonApiCspDirectiveOutDocument -from gooddata_api_client.model.json_api_csp_directive_patch_document import JsonApiCspDirectivePatchDocument +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. @@ -17392,36 +19318,44 @@ 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_csp_directive_patch_document = JsonApiCspDirectivePatchDocument( - data=JsonApiCspDirectivePatch( - attributes=JsonApiCspDirectivePatchAttributes( - sources=[ - "sources_example", + 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="cspDirective", + type="dashboardPlugin", ), - ) # JsonApiCspDirectivePatchDocument | - filter = "sources==v1,v2,v3" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # 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 CSP Directives - api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document) + # 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_csp_directives: %s\n" % 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 CSP Directives - api_response = api_instance.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, filter=filter) + # 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_csp_directives: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_dashboard_plugins: %s\n" % e) ``` @@ -17429,13 +19363,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_csp_directive_patch_document** | [**JsonApiCspDirectivePatchDocument**](JsonApiCspDirectivePatchDocument.md)| | + **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 -[**JsonApiCspDirectiveOutDocument**](JsonApiCspDirectiveOutDocument.md) +[**JsonApiDashboardPluginOutDocument**](JsonApiDashboardPluginOutDocument.md) ### Authorization @@ -17455,10 +19391,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) -# **patch_entity_custom_application_settings** -> JsonApiCustomApplicationSettingOutDocument patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) +# **patch_entity_data_sources** +> JsonApiDataSourceOutDocument patch_entity_data_sources(id, json_api_data_source_patch_document) -Patch a Custom Application Setting +Patch Data Source entity + +Data Source - represents data source for the workspace ### Example @@ -17467,8 +19405,8 @@ Patch a Custom Application Setting import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_application_setting_patch_document import JsonApiCustomApplicationSettingPatchDocument -from gooddata_api_client.model.json_api_custom_application_setting_out_document import JsonApiCustomApplicationSettingOutDocument +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. @@ -17481,36 +19419,56 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_custom_application_setting_patch_document = JsonApiCustomApplicationSettingPatchDocument( - data=JsonApiCustomApplicationSettingPatch( - attributes=JsonApiCustomApplicationSettingPatchAttributes( - application_name="application_name_example", - content={}, + 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", + ), + ], + 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="customApplicationSetting", + type="dataSource", ), - ) # JsonApiCustomApplicationSettingPatchDocument | - 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) + ) # 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 a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document) + # 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_custom_application_settings: %s\n" % 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 a Custom Application Setting - api_response = api_instance.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, filter=filter) + # 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_custom_application_settings: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) ``` @@ -17518,14 +19476,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_custom_application_setting_patch_document** | [**JsonApiCustomApplicationSettingPatchDocument**](JsonApiCustomApplicationSettingPatchDocument.md)| | + **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 -[**JsonApiCustomApplicationSettingOutDocument**](JsonApiCustomApplicationSettingOutDocument.md) +[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) ### Authorization @@ -17545,10 +19502,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_custom_geo_collections** -> JsonApiCustomGeoCollectionOutDocument patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document) +# **patch_entity_datasets** +> JsonApiDatasetOutDocument patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document) -Patch Custom Geo Collection +Patch a Dataset (beta) ### Example @@ -17557,8 +19514,8 @@ Patch Custom Geo Collection import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_custom_geo_collection_patch_document import JsonApiCustomGeoCollectionPatchDocument -from gooddata_api_client.model.json_api_custom_geo_collection_out_document import JsonApiCustomGeoCollectionOutDocument +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. @@ -17571,35 +19528,42 @@ 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_custom_geo_collection_patch_document = JsonApiCustomGeoCollectionPatchDocument( - data=JsonApiCustomGeoCollectionPatch( - attributes=JsonApiCustomGeoCollectionInAttributes( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_dataset_patch_document = JsonApiDatasetPatchDocument( + data=JsonApiDatasetPatch( + attributes=JsonApiDatasetPatchAttributes( description="description_example", - name="name_example", + tags=[ + "tags_example", + ], + title="title_example", ), id="id1", - type="customGeoCollection", + type="dataset", ), - ) # JsonApiCustomGeoCollectionPatchDocument | - filter = "name==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) + ) # 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 = [ + "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 Custom Geo Collection - api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_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_custom_geo_collections: %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 Custom Geo Collection - api_response = api_instance.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, filter=filter) + # 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_custom_geo_collections: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) ``` @@ -17607,13 +19571,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_custom_geo_collection_patch_document** | [**JsonApiCustomGeoCollectionPatchDocument**](JsonApiCustomGeoCollectionPatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **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 -[**JsonApiCustomGeoCollectionOutDocument**](JsonApiCustomGeoCollectionOutDocument.md) +[**JsonApiDatasetOutDocument**](JsonApiDatasetOutDocument.md) ### Authorization @@ -17633,10 +19599,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_dashboard_plugins** -> JsonApiDashboardPluginOutDocument patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document) +# **patch_entity_export_definitions** +> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) -Patch a Plugin +Patch an Export Definition ### Example @@ -17645,8 +19611,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_export_definition_out_document import JsonApiExportDefinitionOutDocument +from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument 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. @@ -17661,42 +19627,50 @@ 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( + json_api_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( + data=JsonApiExportDefinitionPatch( + attributes=JsonApiExportDefinitionInAttributes( are_relations_valid=True, - content={}, description="description_example", + request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), tags=[ "tags_example", ], title="title_example", ), id="id1", - type="dashboardPlugin", + relationships=JsonApiExportDefinitionInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( + data=JsonApiVisualizationObjectToOneLinkage(None), + ), + ), + type="exportDefinition", ), - ) # 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) + ) # JsonApiExportDefinitionPatchDocument | + filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy", + "visualizationObject,analyticalDashboard,automation,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) + # Patch an Export Definition + api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_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_export_definitions: %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 an Export Definition + api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_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_export_definitions: %s\n" % e) ``` @@ -17706,13 +19680,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_dashboard_plugin_patch_document** | [**JsonApiDashboardPluginPatchDocument**](JsonApiDashboardPluginPatchDocument.md)| | + **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.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) +[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) ### Authorization @@ -17732,12 +19706,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_export_templates** +> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) -Data Source - represents data source for the workspace +Patch Export Template entity ### Example @@ -17746,8 +19718,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_export_template_out_document import JsonApiExportTemplateOutDocument +from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -17761,54 +19733,100 @@ 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", + json_api_export_template_patch_document = JsonApiExportTemplatePatchDocument( + data=JsonApiExportTemplatePatch( + attributes=JsonApiExportTemplatePatchAttributes( + dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + cover_slide=CoverSlideTemplate( + background_image=True, + description_field="Exported at: {{exportedAt}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + intro_slide=IntroSlideTemplate( + background_image=True, + description_field='''About: +{{dashboardDescription}} + +{{dashboardFilters}}''', + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + title_field="Introduction", + ), + section_slide=SectionSlideTemplate( + background_image=True, + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), + ), + ), name="name_example", - parameters=[ - JsonApiDataSourceInAttributesParametersInner( - name="name_example", - value="value_example", + widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( + applied_on=["PDF","PPTX"], + content_slide=ContentSlideTemplate( + description_field="{{dashboardFilters}}", + footer=RunningSection( + left="left_example", + right="right_example", + ), + header=RunningSection( + left="left_example", + right="right_example", + ), ), - ], - 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", + type="exportTemplate", ), - ) # 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) + ) # JsonApiExportTemplatePatchDocument | + filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # 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 Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_export_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 Export Template entity + api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_data_sources: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) ``` @@ -17817,12 +19835,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_data_source_patch_document** | [**JsonApiDataSourcePatchDocument**](JsonApiDataSourcePatchDocument.md)| | + **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] ### Return type -[**JsonApiDataSourceOutDocument**](JsonApiDataSourceOutDocument.md) +[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) ### Authorization @@ -17842,10 +19860,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_facts** +> JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) -Patch a Dataset (beta) +Patch a Fact (beta) ### Example @@ -17854,8 +19872,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_fact_out_document import JsonApiFactOutDocument +from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument 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. @@ -17870,9 +19888,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_dataset_patch_document = JsonApiDatasetPatchDocument( - data=JsonApiDatasetPatch( - attributes=JsonApiAttributePatchAttributes( + json_api_fact_patch_document = JsonApiFactPatchDocument( + data=JsonApiFactPatch( + attributes=JsonApiDatasetPatchAttributes( description="description_example", tags=[ "tags_example", @@ -17880,30 +19898,30 @@ with gooddata_api_client.ApiClient() as api_client: title="title_example", ), id="id1", - type="dataset", + type="fact", ), - ) # 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) + ) # JsonApiFactPatchDocument | + filter = "title==someString;description==someString;dataset.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", + "dataset", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Fact (beta) + api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_facts: %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 Fact (beta) + api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_datasets: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_facts: %s\n" % e) ``` @@ -17913,13 +19931,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_dataset_patch_document** | [**JsonApiDatasetPatchDocument**](JsonApiDatasetPatchDocument.md)| | + **json_api_fact_patch_document** | [**JsonApiFactPatchDocument**](JsonApiFactPatchDocument.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) +[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) ### Authorization @@ -17939,10 +19957,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **patch_entity_export_definitions** -> JsonApiExportDefinitionOutDocument patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) +# **patch_entity_filter_contexts** +> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) -Patch an Export Definition +Patch a Filter Context ### Example @@ -17951,8 +19969,8 @@ Patch an Export Definition import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_definition_out_document import JsonApiExportDefinitionOutDocument -from gooddata_api_client.model.json_api_export_definition_patch_document import JsonApiExportDefinitionPatchDocument +from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument +from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument 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. @@ -17967,50 +19985,42 @@ 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_export_definition_patch_document = JsonApiExportDefinitionPatchDocument( - data=JsonApiExportDefinitionPatch( - attributes=JsonApiExportDefinitionInAttributes( + json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( + data=JsonApiFilterContextPatch( + attributes=JsonApiFilterContextPatchAttributes( are_relations_valid=True, + content={}, description="description_example", - request_payload=JsonApiExportDefinitionInAttributesRequestPayload(), tags=[ "tags_example", ], title="title_example", ), id="id1", - relationships=JsonApiExportDefinitionInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - visualization_object=JsonApiExportDefinitionInRelationshipsVisualizationObject( - data=JsonApiVisualizationObjectToOneLinkage(None), - ), - ), - type="exportDefinition", + type="filterContext", ), - ) # JsonApiExportDefinitionPatchDocument | - filter = "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiFilterContextPatchDocument | + 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 = [ - "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document) + # Patch a Filter Context + api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_filter_contexts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch an Export Definition - api_response = api_instance.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, filter=filter, include=include) + # Patch a Filter Context + api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_export_definitions: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_filter_contexts: %s\n" % e) ``` @@ -18020,13 +20030,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_export_definition_patch_document** | [**JsonApiExportDefinitionPatchDocument**](JsonApiExportDefinitionPatchDocument.md)| | + **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.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 -[**JsonApiExportDefinitionOutDocument**](JsonApiExportDefinitionOutDocument.md) +[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) ### Authorization @@ -18046,10 +20056,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **patch_entity_export_templates** -> JsonApiExportTemplateOutDocument patch_entity_export_templates(id, json_api_export_template_patch_document) +# **patch_entity_filter_views** +> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) -Patch Export Template entity +Patch Filter view ### Example @@ -18058,8 +20068,8 @@ Patch Export Template entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_export_template_out_document import JsonApiExportTemplateOutDocument -from gooddata_api_client.model.json_api_export_template_patch_document import JsonApiExportTemplatePatchDocument +from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument +from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument 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. @@ -18072,101 +20082,53 @@ 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_export_template_patch_document = JsonApiExportTemplatePatchDocument( - data=JsonApiExportTemplatePatch( - attributes=JsonApiExportTemplatePatchAttributes( - dashboard_slides_template=JsonApiExportTemplateInAttributesDashboardSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - cover_slide=CoverSlideTemplate( - background_image=True, - description_field="Exported at: {{exportedAt}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - intro_slide=IntroSlideTemplate( - background_image=True, - description_field='''About: -{{dashboardDescription}} - -{{dashboardFilters}}''', - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - title_field="Introduction", - ), - section_slide=SectionSlideTemplate( - background_image=True, - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), - ), - name="name_example", - widget_slides_template=JsonApiExportTemplateInAttributesWidgetSlidesTemplate( - applied_on=["PDF","PPTX"], - content_slide=ContentSlideTemplate( - description_field="{{dashboardFilters}}", - footer=RunningSection( - left="left_example", - right="right_example", - ), - header=RunningSection( - left="left_example", - right="right_example", - ), - ), + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_filter_view_patch_document = JsonApiFilterViewPatchDocument( + data=JsonApiFilterViewPatch( + attributes=JsonApiFilterViewPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + is_default=True, + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + relationships=JsonApiFilterViewInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + user=JsonApiFilterViewInRelationshipsUser( + data=JsonApiUserToOneLinkage(None), ), ), - id="id1", - type="exportTemplate", + type="filterView", ), - ) # JsonApiExportTemplatePatchDocument | - filter = "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiFilterViewPatchDocument | + filter = "title==someString;description==someString;analyticalDashboard.id==321;user.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 = [ + "analyticalDashboard,user", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document) + # Patch Filter view + api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_filter_views: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Export Template entity - api_response = api_instance.patch_entity_export_templates(id, json_api_export_template_patch_document, filter=filter) + # Patch Filter view + api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_export_templates: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_filter_views: %s\n" % e) ``` @@ -18174,13 +20136,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_export_template_patch_document** | [**JsonApiExportTemplatePatchDocument**](JsonApiExportTemplatePatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.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 -[**JsonApiExportTemplateOutDocument**](JsonApiExportTemplateOutDocument.md) +[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) ### Authorization @@ -18200,10 +20164,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_facts** -> JsonApiFactOutDocument patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) +# **patch_entity_identity_providers** +> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) -Patch a Fact (beta) +Patch Identity Provider ### Example @@ -18212,8 +20176,8 @@ Patch a Fact (beta) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_fact_out_document import JsonApiFactOutDocument -from gooddata_api_client.model.json_api_fact_patch_document import JsonApiFactPatchDocument +from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument +from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18226,42 +20190,50 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_fact_patch_document = JsonApiFactPatchDocument( - data=JsonApiFactPatch( - attributes=JsonApiAttributePatchAttributes( - description="description_example", - tags=[ - "tags_example", + id = "/6bUUGjjNSwg0_bs" # str | + json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( + data=JsonApiIdentityProviderPatch( + attributes=JsonApiIdentityProviderInAttributes( + custom_claim_mapping={ + "key": "key_example", + }, + identifiers=["gooddata.com"], + idp_type="MANAGED_IDP", + oauth_client_id="oauth_client_id_example", + oauth_client_secret="oauth_client_secret_example", + oauth_custom_auth_attributes={ + "key": "key_example", + }, + oauth_custom_scopes=[ + "oauth_custom_scopes_example", ], - title="title_example", + oauth_issuer_id="myOidcProvider", + oauth_issuer_location="oauth_issuer_location_example", + oauth_subject_id_claim="oid", + saml_metadata="saml_metadata_example", ), id="id1", - type="fact", + type="identityProvider", ), - ) # JsonApiFactPatchDocument | - filter = "title==someString;description==someString;dataset.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "dataset", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiIdentityProviderPatchDocument | + filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch a Fact (beta) - api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document) + # Patch Identity Provider + api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_facts: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_identity_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Fact (beta) - api_response = api_instance.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, filter=filter, include=include) + # Patch Identity Provider + api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_facts: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_identity_providers: %s\n" % e) ``` @@ -18269,15 +20241,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_fact_patch_document** | [**JsonApiFactPatchDocument**](JsonApiFactPatchDocument.md)| | + **id** | **str**| | + **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.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 -[**JsonApiFactOutDocument**](JsonApiFactOutDocument.md) +[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) ### Authorization @@ -18297,10 +20267,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) -# **patch_entity_filter_contexts** -> JsonApiFilterContextOutDocument patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) +# **patch_entity_jwks** +> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) -Patch a Filter Context +Patch Jwk + +Patches JSON web key - used to verify JSON web tokens (Jwts) ### Example @@ -18309,8 +20281,8 @@ Patch a Filter Context import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_context_patch_document import JsonApiFilterContextPatchDocument -from gooddata_api_client.model.json_api_filter_context_out_document import JsonApiFilterContextOutDocument +from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument +from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument 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. @@ -18323,44 +20295,34 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_filter_context_patch_document = JsonApiFilterContextPatchDocument( - data=JsonApiFilterContextPatch( - attributes=JsonApiFilterContextPatchAttributes( - are_relations_valid=True, - content={}, - description="description_example", - tags=[ - "tags_example", - ], - title="title_example", + id = "/6bUUGjjNSwg0_bs" # str | + json_api_jwk_patch_document = JsonApiJwkPatchDocument( + data=JsonApiJwkPatch( + attributes=JsonApiJwkInAttributes( + content=JsonApiJwkInAttributesContent(), ), id="id1", - type="filterContext", + type="jwk", ), - ) # JsonApiFilterContextPatchDocument | - 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 = [ - "attributes,datasets,labels", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiJwkPatchDocument | + filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch a Filter Context - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document) + # Patch Jwk + api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_jwks: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Filter Context - api_response = api_instance.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, filter=filter, include=include) + # Patch Jwk + api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_filter_contexts: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_jwks: %s\n" % e) ``` @@ -18368,15 +20330,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_filter_context_patch_document** | [**JsonApiFilterContextPatchDocument**](JsonApiFilterContextPatchDocument.md)| | + **id** | **str**| | + **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.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 -[**JsonApiFilterContextOutDocument**](JsonApiFilterContextOutDocument.md) +[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) ### Authorization @@ -18396,10 +20356,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_filter_views** -> JsonApiFilterViewOutDocument patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) +# **patch_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) -Patch Filter view +Patch a Knowledge Recommendation ### Example @@ -18408,8 +20368,8 @@ Patch Filter view import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_filter_view_patch_document import JsonApiFilterViewPatchDocument -from gooddata_api_client.model.json_api_filter_view_out_document import JsonApiFilterViewOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18424,51 +20384,62 @@ 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_filter_view_patch_document = JsonApiFilterViewPatchDocument( - data=JsonApiFilterViewPatch( - attributes=JsonApiFilterViewPatchAttributes( + json_api_knowledge_recommendation_patch_document = JsonApiKnowledgeRecommendationPatchDocument( + data=JsonApiKnowledgeRecommendationPatch( + attributes=JsonApiKnowledgeRecommendationPatchAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, are_relations_valid=True, - content={}, + comparison_type="MONTH", + confidence=None, description="description_example", - is_default=True, + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, tags=[ "tags_example", ], title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", ), id="id1", - relationships=JsonApiFilterViewInRelationships( + relationships=JsonApiKnowledgeRecommendationOutRelationships( analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( data=JsonApiAnalyticalDashboardToOneLinkage(None), ), - user=JsonApiFilterViewInRelationshipsUser( - data=JsonApiUserToOneLinkage(None), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), ), ), - type="filterView", + type="knowledgeRecommendation", ), - ) # JsonApiFilterViewPatchDocument | - filter = "title==someString;description==someString;analyticalDashboard.id==321;user.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) + ) # JsonApiKnowledgeRecommendationPatchDocument | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "analyticalDashboard,user", + "metric,analyticalDashboard", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document) + # Patch a Knowledge Recommendation + api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_filter_views: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_knowledge_recommendations: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Filter view - api_response = api_instance.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, filter=filter, include=include) + # Patch a Knowledge Recommendation + api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_filter_views: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_knowledge_recommendations: %s\n" % e) ``` @@ -18478,13 +20449,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_filter_view_patch_document** | [**JsonApiFilterViewPatchDocument**](JsonApiFilterViewPatchDocument.md)| | + **json_api_knowledge_recommendation_patch_document** | [**JsonApiKnowledgeRecommendationPatchDocument**](JsonApiKnowledgeRecommendationPatchDocument.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 -[**JsonApiFilterViewOutDocument**](JsonApiFilterViewOutDocument.md) +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) ### Authorization @@ -18504,10 +20475,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_identity_providers** -> JsonApiIdentityProviderOutDocument patch_entity_identity_providers(id, json_api_identity_provider_patch_document) +# **patch_entity_labels** +> JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) -Patch Identity Provider +Patch a Label (beta) ### Example @@ -18516,8 +20487,8 @@ Patch Identity Provider import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_identity_provider_patch_document import JsonApiIdentityProviderPatchDocument -from gooddata_api_client.model.json_api_identity_provider_out_document import JsonApiIdentityProviderOutDocument +from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument +from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument 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. @@ -18530,50 +20501,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) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_identity_provider_patch_document = JsonApiIdentityProviderPatchDocument( - data=JsonApiIdentityProviderPatch( - attributes=JsonApiIdentityProviderInAttributes( - custom_claim_mapping={ - "key": "key_example", - }, - identifiers=["gooddata.com"], - idp_type="MANAGED_IDP", - oauth_client_id="oauth_client_id_example", - oauth_client_secret="oauth_client_secret_example", - oauth_custom_auth_attributes={ - "key": "key_example", - }, - oauth_custom_scopes=[ - "oauth_custom_scopes_example", + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_label_patch_document = JsonApiLabelPatchDocument( + data=JsonApiLabelPatch( + attributes=JsonApiLabelPatchAttributes( + conditional_formatting=JsonApiLabelOutAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + description="description_example", + tags=[ + "tags_example", ], - oauth_issuer_id="myOidcProvider", - oauth_issuer_location="oauth_issuer_location_example", - oauth_subject_id_claim="oid", - saml_metadata="saml_metadata_example", + title="title_example", ), id="id1", - type="identityProvider", + type="label", ), - ) # JsonApiIdentityProviderPatchDocument | - filter = "identifiers==v1,v2,v3;customClaimMapping==MapValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiLabelPatchDocument | + filter = "title==someString;description==someString;attribute.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 = [ + "attribute", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document) + # Patch a Label (beta) + api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_labels: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Identity Provider - api_response = api_instance.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, filter=filter) + # Patch a Label (beta) + api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_identity_providers: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_labels: %s\n" % e) ``` @@ -18581,13 +20559,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_identity_provider_patch_document** | [**JsonApiIdentityProviderPatchDocument**](JsonApiIdentityProviderPatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_label_patch_document** | [**JsonApiLabelPatchDocument**](JsonApiLabelPatchDocument.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 -[**JsonApiIdentityProviderOutDocument**](JsonApiIdentityProviderOutDocument.md) +[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) ### Authorization @@ -18607,12 +20587,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_jwks** -> JsonApiJwkOutDocument patch_entity_jwks(id, json_api_jwk_patch_document) - -Patch Jwk +# **patch_entity_llm_providers** +> JsonApiLlmProviderOutDocument patch_entity_llm_providers(id, json_api_llm_provider_patch_document) -Patches JSON web key - used to verify JSON web tokens (Jwts) +Patch LLM Provider entity ### Example @@ -18621,8 +20599,8 @@ Patches JSON web key - used to verify JSON web tokens (Jwts) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_jwk_patch_document import JsonApiJwkPatchDocument -from gooddata_api_client.model.json_api_jwk_out_document import JsonApiJwkOutDocument +from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument +from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument 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. @@ -18636,33 +20614,42 @@ 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_jwk_patch_document = JsonApiJwkPatchDocument( - data=JsonApiJwkPatch( - attributes=JsonApiJwkInAttributes( - content=JsonApiJwkInAttributesContent(), + json_api_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( + data=JsonApiLlmProviderPatch( + attributes=JsonApiLlmProviderInAttributes( + default_model_id="default_model_id_example", + description="description_example", + models=[ + JsonApiLlmProviderInAttributesModelsInner( + family="OPENAI", + id="id_example", + ), + ], + name="name_example", + provider_config=JsonApiLlmProviderInAttributesProviderConfig(), ), id="id1", - type="jwk", + type="llmProvider", ), - ) # JsonApiJwkPatchDocument | - filter = "content==JwkSpecificationValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiLlmProviderPatchDocument | + filter = "name==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) # example passing only required values which don't have defaults set try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document) + # Patch LLM Provider entity + api_response = api_instance.patch_entity_llm_providers(id, json_api_llm_provider_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_llm_providers: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch Jwk - api_response = api_instance.patch_entity_jwks(id, json_api_jwk_patch_document, filter=filter) + # Patch LLM Provider entity + api_response = api_instance.patch_entity_llm_providers(id, json_api_llm_provider_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_jwks: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_llm_providers: %s\n" % e) ``` @@ -18671,12 +20658,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_jwk_patch_document** | [**JsonApiJwkPatchDocument**](JsonApiJwkPatchDocument.md)| | + **json_api_llm_provider_patch_document** | [**JsonApiLlmProviderPatchDocument**](JsonApiLlmProviderPatchDocument.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 -[**JsonApiJwkOutDocument**](JsonApiJwkOutDocument.md) +[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.md) ### Authorization @@ -18696,10 +20683,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_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) +# **patch_entity_memory_items** +> JsonApiMemoryItemOutDocument patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) -Patch a Knowledge Recommendation +Patch a Memory Item ### Example @@ -18708,8 +20695,8 @@ Patch a Knowledge Recommendation import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -18724,62 +20711,47 @@ 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_knowledge_recommendation_patch_document = JsonApiKnowledgeRecommendationPatchDocument( - data=JsonApiKnowledgeRecommendationPatch( - attributes=JsonApiKnowledgeRecommendationPatchAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, + json_api_memory_item_patch_document = JsonApiMemoryItemPatchDocument( + data=JsonApiMemoryItemPatch( + attributes=JsonApiMemoryItemPatchAttributes( are_relations_valid=True, - comparison_type="MONTH", - confidence=None, description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", tags=[ "tags_example", ], title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", ), id="id1", - relationships=JsonApiKnowledgeRecommendationOutRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", + type="memoryItem", ), - ) # JsonApiKnowledgeRecommendationPatchDocument | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiMemoryItemPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Patch a Knowledge Recommendation - api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) + # Patch a Memory Item + api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Knowledge Recommendation - api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, filter=filter, include=include) + # Patch a Memory Item + api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_memory_items: %s\n" % e) ``` @@ -18789,13 +20761,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_knowledge_recommendation_patch_document** | [**JsonApiKnowledgeRecommendationPatchDocument**](JsonApiKnowledgeRecommendationPatchDocument.md)| | + **json_api_memory_item_patch_document** | [**JsonApiMemoryItemPatchDocument**](JsonApiMemoryItemPatchDocument.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 -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) ### Authorization @@ -18815,10 +20787,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_labels** -> JsonApiLabelOutDocument patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) +# **patch_entity_metrics** +> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) -Patch a Label (beta) +Patch a Metric ### Example @@ -18827,8 +20799,8 @@ Patch a Label (beta) import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument -from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument +from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument +from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument 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. @@ -18843,40 +20815,63 @@ 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_label_patch_document = JsonApiLabelPatchDocument( - data=JsonApiLabelPatch( - attributes=JsonApiAttributePatchAttributes( + json_api_metric_patch_document = JsonApiMetricPatchDocument( + data=JsonApiMetricPatch( + attributes=JsonApiMetricPatchAttributes( + are_relations_valid=True, + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), description="description_example", + is_hidden=True, + is_hidden_from_kda=True, tags=[ "tags_example", ], title="title_example", ), id="id1", - type="label", + type="metric", ), - ) # JsonApiLabelPatchDocument | - filter = "title==someString;description==someString;attribute.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) + ) # JsonApiMetricPatchDocument | + 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 = [ - "attribute", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Label (beta) - api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document) + # Patch a Metric + api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_labels: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_metrics: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Label (beta) - api_response = api_instance.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, filter=filter, include=include) + # Patch a Metric + api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_labels: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_metrics: %s\n" % e) ``` @@ -18886,13 +20881,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_label_patch_document** | [**JsonApiLabelPatchDocument**](JsonApiLabelPatchDocument.md)| | + **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.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 -[**JsonApiLabelOutDocument**](JsonApiLabelOutDocument.md) +[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) ### Authorization @@ -18912,10 +20907,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_llm_providers** -> JsonApiLlmProviderOutDocument patch_entity_llm_providers(id, json_api_llm_provider_patch_document) +# **patch_entity_notification_channels** +> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document) -Patch LLM Provider entity +Patch Notification Channel entity ### Example @@ -18924,8 +20919,8 @@ Patch LLM Provider entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_llm_provider_out_document import JsonApiLlmProviderOutDocument -from gooddata_api_client.model.json_api_llm_provider_patch_document import JsonApiLlmProviderPatchDocument +from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument +from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument 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. @@ -18939,42 +20934,40 @@ 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_llm_provider_patch_document = JsonApiLlmProviderPatchDocument( - data=JsonApiLlmProviderPatch( - attributes=JsonApiLlmProviderInAttributes( - default_model_id="default_model_id_example", + json_api_notification_channel_patch_document = JsonApiNotificationChannelPatchDocument( + data=JsonApiNotificationChannelPatch( + attributes=JsonApiNotificationChannelInAttributes( + allowed_recipients="CREATOR", + custom_dashboard_url="custom_dashboard_url_example", + dashboard_link_visibility="HIDDEN", description="description_example", - models=[ - JsonApiLlmProviderInAttributesModelsInner( - family="OPENAI", - id="id_example", - ), - ], + destination=JsonApiNotificationChannelInAttributesDestination(None), + in_platform_notification="DISABLED", name="name_example", - provider_config=JsonApiLlmProviderInAttributesProviderConfig(), + notification_source="notification_source_example", ), id="id1", - type="llmProvider", + type="notificationChannel", ), - ) # JsonApiLlmProviderPatchDocument | + ) # JsonApiNotificationChannelPatchDocument | filter = "name==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) # example passing only required values which don't have defaults set try: - # Patch LLM Provider entity - api_response = api_instance.patch_entity_llm_providers(id, json_api_llm_provider_patch_document) + # Patch Notification Channel entity + api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_llm_providers: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_notification_channels: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch LLM Provider entity - api_response = api_instance.patch_entity_llm_providers(id, json_api_llm_provider_patch_document, filter=filter) + # Patch Notification Channel entity + api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, filter=filter) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_llm_providers: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_notification_channels: %s\n" % e) ``` @@ -18983,12 +20976,12 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_llm_provider_patch_document** | [**JsonApiLlmProviderPatchDocument**](JsonApiLlmProviderPatchDocument.md)| | + **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.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 -[**JsonApiLlmProviderOutDocument**](JsonApiLlmProviderOutDocument.md) +[**JsonApiNotificationChannelOutDocument**](JsonApiNotificationChannelOutDocument.md) ### Authorization @@ -19008,10 +21001,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_memory_items** -> JsonApiMemoryItemOutDocument patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) +# **patch_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) -Patch a Memory Item +Patch an organization Memory Item entity ### Example @@ -19020,8 +21013,8 @@ Patch a Memory Item import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -19034,12 +21027,10 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_memory_item_patch_document = JsonApiMemoryItemPatchDocument( - data=JsonApiMemoryItemPatch( - attributes=JsonApiMemoryItemPatchAttributes( - are_relations_valid=True, + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( + data=JsonApiOrgMemoryItemPatch( + attributes=JsonApiOrgMemoryItemPatchAttributes( description="description_example", instruction="instruction_example", is_disabled=True, @@ -19047,15 +21038,12 @@ with gooddata_api_client.ApiClient() as api_client: "keywords_example", ], strategy="ALWAYS", - tags=[ - "tags_example", - ], title="title_example", ), id="id1", - type="memoryItem", + type="orgMemoryItem", ), - ) # JsonApiMemoryItemPatchDocument | + ) # JsonApiOrgMemoryItemPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ "createdBy,modifiedBy", @@ -19063,20 +21051,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Memory Item - api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_org_memory_items: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Memory Item - api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, filter=filter, include=include) + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_org_memory_items: %s\n" % e) ``` @@ -19084,15 +21072,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_memory_item_patch_document** | [**JsonApiMemoryItemPatchDocument**](JsonApiMemoryItemPatchDocument.md)| | + **id** | **str**| | + **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) ### Authorization @@ -19112,10 +21099,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_metrics** -> JsonApiMetricOutDocument patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) +# **patch_entity_organization_settings** +> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document) -Patch a Metric +Patch Organization Setting entity ### Example @@ -19124,8 +21111,8 @@ Patch a Metric import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_metric_patch_document import JsonApiMetricPatchDocument -from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument +from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument +from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument 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. @@ -19138,50 +21125,35 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - workspace_id = "workspaceId_example" # str | - object_id = "objectId_example" # str | - json_api_metric_patch_document = JsonApiMetricPatchDocument( - data=JsonApiMetricPatch( - attributes=JsonApiMetricPatchAttributes( - are_relations_valid=True, - content=JsonApiMetricInAttributesContent( - format="format_example", - maql="maql_example", - metric_type="UNSPECIFIED", - ), - description="description_example", - is_hidden=True, - is_hidden_from_kda=True, - tags=[ - "tags_example", - ], - title="title_example", + id = "/6bUUGjjNSwg0_bs" # str | + json_api_organization_setting_patch_document = JsonApiOrganizationSettingPatchDocument( + data=JsonApiOrganizationSettingPatch( + attributes=JsonApiOrganizationSettingInAttributes( + content={}, + type="TIMEZONE", ), id="id1", - type="metric", + type="organizationSetting", ), - ) # JsonApiMetricPatchDocument | - filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) - include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", - ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + ) # JsonApiOrganizationSettingPatchDocument | + filter = "content==JsonNodeValue;type==SettingTypeValue" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) # example passing only required values which don't have defaults set try: - # Patch a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document) + # Patch Organization Setting entity + 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_metrics: %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 a Metric - api_response = api_instance.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, filter=filter, include=include) + # 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_metrics: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_organization_settings: %s\n" % e) ``` @@ -19189,15 +21161,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **object_id** | **str**| | - **json_api_metric_patch_document** | [**JsonApiMetricPatchDocument**](JsonApiMetricPatchDocument.md)| | + **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] - **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 -[**JsonApiMetricOutDocument**](JsonApiMetricOutDocument.md) +[**JsonApiOrganizationSettingOutDocument**](JsonApiOrganizationSettingOutDocument.md) ### Authorization @@ -19217,10 +21187,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_notification_channels** -> JsonApiNotificationChannelOutDocument patch_entity_notification_channels(id, json_api_notification_channel_patch_document) +# **patch_entity_organizations** +> JsonApiOrganizationOutDocument patch_entity_organizations(id, json_api_organization_patch_document) -Patch Notification Channel entity +Patch Organization ### Example @@ -19229,8 +21199,8 @@ Patch Notification Channel entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_notification_channel_out_document import JsonApiNotificationChannelOutDocument -from gooddata_api_client.model.json_api_notification_channel_patch_document import JsonApiNotificationChannelPatchDocument +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. @@ -19244,40 +21214,49 @@ 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_notification_channel_patch_document = JsonApiNotificationChannelPatchDocument( - data=JsonApiNotificationChannelPatch( - attributes=JsonApiNotificationChannelInAttributes( - allowed_recipients="CREATOR", - custom_dashboard_url="custom_dashboard_url_example", - dashboard_link_visibility="HIDDEN", - description="description_example", - destination=JsonApiNotificationChannelInAttributesDestination(None), - in_platform_notification="DISABLED", + 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", - notification_source="notification_source_example", ), id="id1", - type="notificationChannel", + relationships=JsonApiOrganizationInRelationships( + identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( + data=JsonApiIdentityProviderToOneLinkage(None), + ), + ), + type="organization", ), - ) # JsonApiNotificationChannelPatchDocument | - filter = "name==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) + ) # 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 Notification Channel entity - api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_patch_document) + # 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_notification_channels: %s\n" % 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 Notification Channel entity - api_response = api_instance.patch_entity_notification_channels(id, json_api_notification_channel_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_notification_channels: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_organizations: %s\n" % e) ``` @@ -19286,12 +21265,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **str**| | - **json_api_notification_channel_patch_document** | [**JsonApiNotificationChannelPatchDocument**](JsonApiNotificationChannelPatchDocument.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 -[**JsonApiNotificationChannelOutDocument**](JsonApiNotificationChannelOutDocument.md) +[**JsonApiOrganizationOutDocument**](JsonApiOrganizationOutDocument.md) ### Authorization @@ -19311,10 +21291,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_org_memory_items** -> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) +# **patch_entity_parameters** +> JsonApiParameterOutDocument patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document) -Patch an organization Memory Item entity +Patch a Parameter ### Example @@ -19323,8 +21303,8 @@ Patch an organization Memory Item entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_parameter_patch_document import JsonApiParameterPatchDocument +from gooddata_api_client.model.json_api_parameter_out_document import JsonApiParameterOutDocument 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. @@ -19337,23 +21317,23 @@ configuration = gooddata_api_client.Configuration( with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = entities_api.EntitiesApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( - data=JsonApiOrgMemoryItemPatch( - attributes=JsonApiOrgMemoryItemPatchAttributes( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_parameter_patch_document = JsonApiParameterPatchDocument( + data=JsonApiParameterPatch( + attributes=JsonApiParameterPatchAttributes( + are_relations_valid=True, + definition=JsonApiParameterInAttributesDefinition(), description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", + tags=[ + "tags_example", ], - strategy="ALWAYS", title="title_example", ), id="id1", - type="orgMemoryItem", + type="parameter", ), - ) # JsonApiOrgMemoryItemPatchDocument | + ) # JsonApiParameterPatchDocument | 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", @@ -19361,20 +21341,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch an organization Memory Item entity - api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + # Patch a Parameter + api_response = api_instance.patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_org_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_parameters: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch an organization Memory Item entity - api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) + # Patch a Parameter + api_response = api_instance.patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_org_memory_items: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_parameters: %s\n" % e) ``` @@ -19382,14 +21362,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_parameter_patch_document** | [**JsonApiParameterPatchDocument**](JsonApiParameterPatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) +[**JsonApiParameterOutDocument**](JsonApiParameterOutDocument.md) ### Authorization @@ -19409,10 +21390,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_organization_settings** -> JsonApiOrganizationSettingOutDocument patch_entity_organization_settings(id, json_api_organization_setting_patch_document) +# **patch_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document) -Patch Organization Setting entity +Patch a Report Page Layout ### Example @@ -19421,8 +21402,8 @@ Patch Organization Setting entity import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_organization_setting_out_document import JsonApiOrganizationSettingOutDocument -from gooddata_api_client.model.json_api_organization_setting_patch_document import JsonApiOrganizationSettingPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument 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. @@ -19435,35 +21416,44 @@ 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_setting_patch_document = JsonApiOrganizationSettingPatchDocument( - data=JsonApiOrganizationSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_page_layout_patch_document = JsonApiReportPageLayoutPatchDocument( + data=JsonApiReportPageLayoutPatch( + attributes=JsonApiReportPageLayoutPatchAttributes( + are_relations_valid=True, content={}, - type="TIMEZONE", + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", ), id="id1", - type="organizationSetting", + type="reportPageLayout", ), - ) # JsonApiOrganizationSettingPatchDocument | - 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) + ) # JsonApiReportPageLayoutPatchDocument | + 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 Organization Setting entity - api_response = api_instance.patch_entity_organization_settings(id, json_api_organization_setting_patch_document) + # Patch a Report Page Layout + api_response = api_instance.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_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_report_page_layouts: %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 a Report Page Layout + api_response = api_instance.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_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_report_page_layouts: %s\n" % e) ``` @@ -19471,13 +21461,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_organization_setting_patch_document** | [**JsonApiOrganizationSettingPatchDocument**](JsonApiOrganizationSettingPatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_page_layout_patch_document** | [**JsonApiReportPageLayoutPatchDocument**](JsonApiReportPageLayoutPatchDocument.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) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -19497,10 +21489,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_report_templates** +> JsonApiReportTemplateOutDocument patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document) -Patch Organization +Patch a Report Template ### Example @@ -19509,8 +21501,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_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -19523,50 +21515,44 @@ 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_report_template_patch_document = JsonApiReportTemplatePatchDocument( + data=JsonApiReportTemplatePatch( + attributes=JsonApiReportTemplatePatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", ], - hostname="hostname_example", - name="name_example", + title="title_example", ), id="id1", - relationships=JsonApiOrganizationInRelationships( - identity_provider=JsonApiOrganizationInRelationshipsIdentityProvider( - data=JsonApiIdentityProviderToOneLinkage(None), - ), - ), - type="organization", + type="reportTemplate", ), - ) # 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) + ) # JsonApiReportTemplatePatchDocument | + 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 = [ - "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 Report Template + api_response = api_instance.patch_entity_report_templates(workspace_id, object_id, json_api_report_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_report_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 Report Template + api_response = api_instance.patch_entity_report_templates(workspace_id, object_id, json_api_report_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_report_templates: %s\n" % e) ``` @@ -19574,14 +21560,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_report_template_patch_document** | [**JsonApiReportTemplatePatchDocument**](JsonApiReportTemplatePatchDocument.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) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -19601,10 +21588,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_parameters** -> JsonApiParameterOutDocument patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document) +# **patch_entity_reports** +> JsonApiReportOutDocument patch_entity_reports(workspace_id, object_id, json_api_report_patch_document) -Patch a Parameter +Patch a Report ### Example @@ -19613,8 +21600,8 @@ Patch a Parameter import time import gooddata_api_client from gooddata_api_client.api import entities_api -from gooddata_api_client.model.json_api_parameter_patch_document import JsonApiParameterPatchDocument -from gooddata_api_client.model.json_api_parameter_out_document import JsonApiParameterOutDocument +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument 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. @@ -19629,21 +21616,24 @@ 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_parameter_patch_document = JsonApiParameterPatchDocument( - data=JsonApiParameterPatch( - attributes=JsonApiParameterPatchAttributes( + json_api_report_patch_document = JsonApiReportPatchDocument( + data=JsonApiReportPatch( + attributes=JsonApiReportPatchAttributes( are_relations_valid=True, - definition=JsonApiParameterInAttributesDefinition(), + content={}, description="description_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), tags=[ "tags_example", ], title="title_example", + variable_values=None, ), id="id1", - type="parameter", + type="report", ), - ) # JsonApiParameterPatchDocument | + ) # JsonApiReportPatchDocument | 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", @@ -19651,20 +21641,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Parameter - api_response = api_instance.patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document) + # Patch a Report + api_response = api_instance.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Parameter - api_response = api_instance.patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document, filter=filter, include=include) + # Patch a Report + api_response = api_instance.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling EntitiesApi->patch_entity_parameters: %s\n" % e) + print("Exception when calling EntitiesApi->patch_entity_reports: %s\n" % e) ``` @@ -19674,13 +21664,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_parameter_patch_document** | [**JsonApiParameterPatchDocument**](JsonApiParameterPatchDocument.md)| | + **json_api_report_patch_document** | [**JsonApiReportPatchDocument**](JsonApiReportPatchDocument.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 -[**JsonApiParameterOutDocument**](JsonApiParameterOutDocument.md) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization @@ -19841,7 +21831,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiUserDataFilterPatchDocument | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -20137,6 +22127,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectPatch( attributes=JsonApiVisualizationObjectPatchAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -20151,7 +22162,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiVisualizationObjectPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -20688,7 +22699,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -21535,6 +23546,105 @@ No authorization required - **Accept**: application/json, application/vnd.gooddata.api+json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_computed_attributes** +> JsonApiComputedAttributeOutList search_entities_computed_attributes(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = entities_api.EntitiesApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->search_entities_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_computed_attributes(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->search_entities_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiComputedAttributeOutList**](JsonApiComputedAttributeOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + ### HTTP response details | Status code | Description | Response headers | @@ -23328,6 +25438,14 @@ with gooddata_api_client.ApiClient() as api_client: ], description="description_example", enabled=True, + instructions=[ + JsonApiAgentInAttributesInstructionsInner( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], is_preview=True, name="name_example", personality="personality_example", @@ -23448,7 +25566,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAnalyticalDashboardInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", + "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -23667,6 +25785,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), are_relations_valid=True, @@ -23833,6 +25956,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ JsonApiAutomationInAttributesTabularExportsInner( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -23953,7 +26097,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiAutomationInDocument | filter = "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -24075,7 +26219,116 @@ Name | Type | Description | Notes ### Return type -[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.md) +[**JsonApiColorPaletteOutDocument**](JsonApiColorPaletteOutDocument.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_computed_attributes** +> JsonApiComputedAttributeOutDocument update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document) + +Put a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +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_computed_attribute_in_document = JsonApiComputedAttributeInDocument( + data=JsonApiComputedAttributeIn( + attributes=JsonApiComputedAttributeInAttributes( + are_relations_valid=True, + content=JsonApiComputedAttributeInAttributesContent( + format="format_example", + maql="maql_example", + metric_type="UNSPECIFIED", + ), + data_type="INT", + description="description_example", + is_hidden=True, + is_nullable=True, + locale="locale_example", + null_value="null_value_example", + tags=[ + "tags_example", + ], + title="title_example", + value_type="TEXT", + ), + id="id1", + type="computedAttribute", + ), + ) # JsonApiComputedAttributeInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 Computed Attribute + api_response = api_instance.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_computed_attributes: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Computed Attribute + api_response = api_instance.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_computed_attributes: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_computed_attribute_in_document** | [**JsonApiComputedAttributeInDocument**](JsonApiComputedAttributeInDocument.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 + +[**JsonApiComputedAttributeOutDocument**](JsonApiComputedAttributeOutDocument.md) ### Authorization @@ -24681,6 +26934,7 @@ with gooddata_api_client.ApiClient() as api_client: client_id="client_id_example", client_secret="client_secret_example", date_time_semantics="LOCAL", + disable_statistics=True, name="name_example", parameters=[ JsonApiDataSourceInAttributesParametersInner( @@ -25058,7 +27312,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiFilterContextInDocument | 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 = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -25874,7 +28128,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricIn( attributes=JsonApiMetricInAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -25893,7 +28162,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiMetricInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -26422,6 +28691,306 @@ 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_report_page_layouts** +> JsonApiReportPageLayoutOutDocument update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document) + +Put a Report Page Layout + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_in_document import JsonApiReportPageLayoutInDocument +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_report_page_layout_in_document = JsonApiReportPageLayoutInDocument( + data=JsonApiReportPageLayoutIn( + attributes=JsonApiReportPageLayoutInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportPageLayout", + ), + ) # JsonApiReportPageLayoutInDocument | + 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 Report Page Layout + api_response = api_instance.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Report Page Layout + api_response = api_instance.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_report_page_layouts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_page_layout_in_document** | [**JsonApiReportPageLayoutInDocument**](JsonApiReportPageLayoutInDocument.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 + +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.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_report_templates** +> JsonApiReportTemplateOutDocument update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document) + +Put a Report Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +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_report_template_in_document = JsonApiReportTemplateInDocument( + data=JsonApiReportTemplateIn( + attributes=JsonApiReportTemplateInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportTemplate", + ), + ) # JsonApiReportTemplateInDocument | + 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 Report Template + api_response = api_instance.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_report_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Report Template + api_response = api_instance.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_report_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_template_in_document** | [**JsonApiReportTemplateInDocument**](JsonApiReportTemplateInDocument.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 + +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.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_reports** +> JsonApiReportOutDocument update_entity_reports(workspace_id, object_id, json_api_report_in_document) + +Put a Report + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import entities_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_in_document import JsonApiReportInDocument +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_report_in_document = JsonApiReportInDocument( + data=JsonApiReportIn( + attributes=JsonApiReportInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", + ], + title="title_example", + variable_values=None, + ), + id="id1", + type="report", + ), + ) # JsonApiReportInDocument | + 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 Report + api_response = api_instance.update_entity_reports(workspace_id, object_id, json_api_report_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Report + api_response = api_instance.update_entity_reports(workspace_id, object_id, json_api_report_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling EntitiesApi->update_entity_reports: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_in_document** | [**JsonApiReportInDocument**](JsonApiReportInDocument.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 + +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.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 | @@ -26571,7 +29140,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiUserDataFilterInDocument | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -26758,7 +29327,7 @@ with gooddata_api_client.ApiClient() as api_client: id = "/6bUUGjjNSwg0_bs" # str | json_api_user_setting_in_document = JsonApiUserSettingInDocument( data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -26957,6 +29526,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectIn( attributes=JsonApiVisualizationObjectInAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -26971,7 +29561,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiVisualizationObjectInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -27508,7 +30098,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), diff --git a/gooddata-api-client/docs/ErrorInfo.md b/gooddata-api-client/docs/ErrorInfo.md deleted file mode 100644 index 4b79db28e..000000000 --- a/gooddata-api-client/docs/ErrorInfo.md +++ /dev/null @@ -1,14 +0,0 @@ -# ErrorInfo - -Structured error, present when the search could not run (e.g. metadata sync in progress). Absent on success. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **str** | Stable machine-readable error code. Switch on this for localized client messages. | -**status_code** | **int** | HTTP-like semantic status (e.g. 503 when the workspace is still syncing). | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ExportRequest.md b/gooddata-api-client/docs/ExportRequest.md index 1dc32c6ee..ddc784692 100644 --- a/gooddata-api-client/docs/ExportRequest.md +++ b/gooddata-api-client/docs/ExportRequest.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **metadata** | [**JsonNode**](JsonNode.md) | | [optional] **timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] +**conditional_formatting** | [**ConditionalFormatting**](ConditionalFormatting.md) | | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] **execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] diff --git a/gooddata-api-client/docs/FactControllerApi.md b/gooddata-api-client/docs/FactControllerApi.md index df90c3c3e..98e902785 100644 --- a/gooddata-api-client/docs/FactControllerApi.md +++ b/gooddata-api-client/docs/FactControllerApi.md @@ -48,7 +48,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -139,7 +139,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -224,7 +224,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_fact_patch_document = JsonApiFactPatchDocument( data=JsonApiFactPatch( - attributes=JsonApiAttributePatchAttributes( + attributes=JsonApiDatasetPatchAttributes( description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/FactsApi.md b/gooddata-api-client/docs/FactsApi.md index 43d302eb6..cbfd0414a 100644 --- a/gooddata-api-client/docs/FactsApi.md +++ b/gooddata-api-client/docs/FactsApi.md @@ -147,7 +147,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -326,7 +326,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -411,7 +411,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_fact_patch_document = JsonApiFactPatchDocument( data=JsonApiFactPatch( - attributes=JsonApiAttributePatchAttributes( + attributes=JsonApiDatasetPatchAttributes( description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/FailedOperation.md b/gooddata-api-client/docs/FailedOperation.md index dc1bd115e..bf6166a1f 100644 --- a/gooddata-api-client/docs/FailedOperation.md +++ b/gooddata-api-client/docs/FailedOperation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **error** | [**OperationError**](OperationError.md) | | **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | **status** | **str** | | defaults to "failed" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/FileFlowInput.md b/gooddata-api-client/docs/FileFlowInput.md new file mode 100644 index 000000000..a3a5cac03 --- /dev/null +++ b/gooddata-api-client/docs/FileFlowInput.md @@ -0,0 +1,15 @@ +# FileFlowInput + +Reads the latest version of a table uploaded to a GDSTORAGE data source. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_id** | **str** | Identifier of the GDSTORAGE data source. | +**table** | **str** | Name of the table in the data source. | +**type** | **str** | Type of the input. | defaults to "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/AiUsageMetadataItem.md b/gooddata-api-client/docs/FileFlowInputAllOf.md similarity index 62% rename from gooddata-api-client/docs/AiUsageMetadataItem.md rename to gooddata-api-client/docs/FileFlowInputAllOf.md index d0f1f239b..33f52cb7d 100644 --- a/gooddata-api-client/docs/AiUsageMetadataItem.md +++ b/gooddata-api-client/docs/FileFlowInputAllOf.md @@ -1,13 +1,12 @@ -# AiUsageMetadataItem +# FileFlowInputAllOf -AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit). ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**counter_type** | **str** | Type of usage counter, e.g. AI_QUERIES. | -**current_value** | **int** | Current usage value after this request. | -**limit** | **int** | Entitlement limit. 0 means unlimited. | +**data_source_id** | **str** | Identifier of the GDSTORAGE data source. | [optional] +**table** | **str** | Name of the table in the data source. | [optional] +**type** | **str** | Type of the input. | [optional] if omitted the server will use the default value of "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/FilterContextApi.md b/gooddata-api-client/docs/FilterContextApi.md index e15c70a98..48265b7b2 100644 --- a/gooddata-api-client/docs/FilterContextApi.md +++ b/gooddata-api-client/docs/FilterContextApi.md @@ -56,7 +56,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiFilterContextPostOptionalIdDocument | include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -206,7 +206,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -302,7 +302,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -406,7 +406,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiFilterContextPatchDocument | 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 = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -604,7 +604,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiFilterContextInDocument | 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 = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/FilterContextControllerApi.md b/gooddata-api-client/docs/FilterContextControllerApi.md index b33732a1b..cd1400022 100644 --- a/gooddata-api-client/docs/FilterContextControllerApi.md +++ b/gooddata-api-client/docs/FilterContextControllerApi.md @@ -56,7 +56,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiFilterContextPostOptionalIdDocument | include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -206,7 +206,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -302,7 +302,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -406,7 +406,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiFilterContextPatchDocument | 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 = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -604,7 +604,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiFilterContextInDocument | 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 = [ - "attributes,datasets,labels", + "attributes,datasets,labels,computedAttributes,metrics,facts", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/FlowApi.md b/gooddata-api-client/docs/FlowApi.md new file mode 100644 index 000000000..f66359e7e --- /dev/null +++ b/gooddata-api-client/docs/FlowApi.md @@ -0,0 +1,478 @@ +# gooddata_api_client.FlowApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**cancel_flows**](FlowApi.md#cancel_flows) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel | (EXPERIMENTAL) Apply the given cancel tokens to flows +[**execute_flow**](FlowApi.md#execute_flow) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/flow | (EXPERIMENTAL) Execute a flow +[**list_flow_operations**](FlowApi.md#list_flow_operations) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/operations | (EXPERIMENTAL) List the operations of flows +[**retrieve_flow_result_binary**](FlowApi.md#retrieve_flow_result_binary) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary | (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format +[**retrieve_flow_result_metadata**](FlowApi.md#retrieve_flow_result_metadata) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata | (EXPERIMENTAL) Get the metadata of a flow result +[**retrieve_flow_result_table**](FlowApi.md#retrieve_flow_result_table) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table | (EXPERIMENTAL) Get a page of a flow result + + +# **cancel_flows** +> AfmCancelTokens cancel_flows(workspace_id, afm_cancel_tokens) + +(EXPERIMENTAL) Apply the given cancel tokens to flows + +Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import flow_api +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens +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 = flow_api.FlowApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + afm_cancel_tokens = AfmCancelTokens( + result_id_to_cancel_token_pairs={ + "key": "key_example", + }, + ) # AfmCancelTokens | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Apply the given cancel tokens to flows + api_response = api_instance.cancel_flows(workspace_id, afm_cancel_tokens) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->cancel_flows: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **afm_cancel_tokens** | [**AfmCancelTokens**](AfmCancelTokens.md)| | + +### Return type + +[**AfmCancelTokens**](AfmCancelTokens.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **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) + +# **execute_flow** +> FlowExecutionResponse execute_flow(workspace_id, flow_request) + +(EXPERIMENTAL) Execute a flow + +Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import flow_api +from gooddata_api_client.model.flow_execution_response import FlowExecutionResponse +from gooddata_api_client.model.flow_request import FlowRequest +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 = flow_api.FlowApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + flow_request = FlowRequest( + inputs={ + "key": FlowInput(), + }, + transformations=[ + FlowTransformation( + id="id_example", + input_refs={ + "key": "key_example", + }, + operation="survey_weighting", + parameters={}, + ), + ], + ) # FlowRequest | + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Execute a flow + api_response = api_instance.execute_flow(workspace_id, flow_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->execute_flow: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **flow_request** | [**FlowRequest**](FlowRequest.md)| | + +### Return type + +[**FlowExecutionResponse**](FlowExecutionResponse.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The flow was accepted. | * X-GDC-CANCEL-TOKEN - A token that can be used to cancel this execution
| + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_flow_operations** +> FlowOperations list_flow_operations(workspace_id) + +(EXPERIMENTAL) List the operations of flows + +Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import flow_api +from gooddata_api_client.model.flow_operations import FlowOperations +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 = flow_api.FlowApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) List the operations of flows + api_response = api_instance.list_flow_operations(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->list_flow_operations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + +### Return type + +[**FlowOperations**](FlowOperations.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) + +# **retrieve_flow_result_binary** +> file_type retrieve_flow_result_binary(workspace_id, result_id) + +(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format + +Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import flow_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 = flow_api.FlowApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + row_offset = 1 # int | Index of the first row to return. The default is 0. (optional) + row_limit = 1 # int | Maximum number of rows to return. The default is all remaining rows. (optional) + column_offset = 1 # int | Index of the first column to return. The default is 0. (optional) + column_limit = 1 # int | Maximum number of columns to return. The default is all remaining columns. (optional) + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format + api_response = api_instance.retrieve_flow_result_binary(workspace_id, result_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->retrieve_flow_result_binary: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format + api_response = api_instance.retrieve_flow_result_binary(workspace_id, result_id, row_offset=row_offset, row_limit=row_limit, column_offset=column_offset, column_limit=column_limit) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->retrieve_flow_result_binary: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **row_offset** | **int**| Index of the first row to return. The default is 0. | [optional] + **row_limit** | **int**| Maximum number of rows to return. The default is all remaining rows. | [optional] + **column_offset** | **int**| Index of the first column to return. The default is 0. | [optional] + **column_limit** | **int**| Maximum number of columns to return. The default is all remaining columns. | [optional] + +### Return type + +**file_type** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.apache.arrow.file, application/vnd.apache.arrow.stream + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The result. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **retrieve_flow_result_metadata** +> FlowResultMetadata retrieve_flow_result_metadata(workspace_id, result_id) + +(EXPERIMENTAL) Get the metadata of a flow result + +Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import flow_api +from gooddata_api_client.model.flow_result_metadata import FlowResultMetadata +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 = flow_api.FlowApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Get the metadata of a flow result + api_response = api_instance.retrieve_flow_result_metadata(workspace_id, result_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->retrieve_flow_result_metadata: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + +### Return type + +[**FlowResultMetadata**](FlowResultMetadata.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) + +# **retrieve_flow_result_table** +> FlowTableResult retrieve_flow_result_table(workspace_id, result_id) + +(EXPERIMENTAL) Get a page of a flow result + +Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import flow_api +from gooddata_api_client.model.flow_table_result import FlowTableResult +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 = flow_api.FlowApi(api_client) + workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier + result_id = "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" # str | Result ID + row_offset = 1 # int | Index of the first row to return. The default is 0. (optional) + row_limit = 1 # int | Maximum number of rows to return. The default is all remaining rows. (optional) + column_offset = 1 # int | Index of the first column to return. The default is 0. (optional) + column_limit = 1 # int | Maximum number of columns to return. The default is all remaining columns. (optional) + + # example passing only required values which don't have defaults set + try: + # (EXPERIMENTAL) Get a page of a flow result + api_response = api_instance.retrieve_flow_result_table(workspace_id, result_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->retrieve_flow_result_table: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Get a page of a flow result + api_response = api_instance.retrieve_flow_result_table(workspace_id, result_id, row_offset=row_offset, row_limit=row_limit, column_offset=column_offset, column_limit=column_limit) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling FlowApi->retrieve_flow_result_table: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| Workspace identifier | + **result_id** | **str**| Result ID | + **row_offset** | **int**| Index of the first row to return. The default is 0. | [optional] + **row_limit** | **int**| Maximum number of rows to return. The default is all remaining rows. | [optional] + **column_offset** | **int**| Index of the first column to return. The default is 0. | [optional] + **column_limit** | **int**| Maximum number of columns to return. The default is all remaining columns. | [optional] + +### Return type + +[**FlowTableResult**](FlowTableResult.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/FlowColumn.md b/gooddata-api-client/docs/FlowColumn.md new file mode 100644 index 000000000..cdb117e7c --- /dev/null +++ b/gooddata-api-client/docs/FlowColumn.md @@ -0,0 +1,15 @@ +# FlowColumn + +A column of a flow result. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**metadata** | **{str: (str,)}** | Metadata of the column, as the operation that produced it gives them. | +**name** | **str** | Name of the column. | +**type** | **str** | Type of the values in the 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/FlowExecutionResponse.md b/gooddata-api-client/docs/FlowExecutionResponse.md new file mode 100644 index 000000000..1a3bc0c5b --- /dev/null +++ b/gooddata-api-client/docs/FlowExecutionResponse.md @@ -0,0 +1,13 @@ +# FlowExecutionResponse + +A submitted flow: where to read its result. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**ExecutionLinks**](ExecutionLinks.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/FlowInput.md b/gooddata-api-client/docs/FlowInput.md new file mode 100644 index 000000000..63b964f91 --- /dev/null +++ b/gooddata-api-client/docs/FlowInput.md @@ -0,0 +1,18 @@ +# FlowInput + +An input of a flow. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] +**data_source_id** | **str** | Identifier of the data source that runs the statement. | [optional] +**table** | **str** | Name of the table in the data source. | [optional] +**type** | **str** | Type of the input. | [optional] if omitted the server will use the default value of "sql" +**execution** | [**AFM**](AFM.md) | | [optional] +**sql** | **str** | One SELECT statement in the SQL dialect of the data source. | [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/FlowOperationDescriptor.md b/gooddata-api-client/docs/FlowOperationDescriptor.md new file mode 100644 index 000000000..9d44c0a1b --- /dev/null +++ b/gooddata-api-client/docs/FlowOperationDescriptor.md @@ -0,0 +1,18 @@ +# FlowOperationDescriptor + +An operation that a transformation can run. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | What the operation does. | +**inputs** | [**[FlowOperationInput]**](FlowOperationInput.md) | Inputs of the operation. The first one is the primary input, named data. | +**name** | **str** | Name of the operation. A transformation gives it as its operation. | +**output** | [**FlowOperationOutput**](FlowOperationOutput.md) | | +**parameters** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | JSON Schema of the parameters of the operation. | +**pure** | **bool** | True when the result depends only on the inputs and the parameters. The result of an impure operation is never reused. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/FlowOperationInput.md b/gooddata-api-client/docs/FlowOperationInput.md new file mode 100644 index 000000000..dd49eb27f --- /dev/null +++ b/gooddata-api-client/docs/FlowOperationInput.md @@ -0,0 +1,14 @@ +# FlowOperationInput + +An input of an operation. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | What the operation expects in the input. | +**name** | **str** | Name of the input. A transformation binds it in its inputRefs. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AttributePositiveFilterAllOf.md b/gooddata-api-client/docs/FlowOperationOutput.md similarity index 80% rename from gooddata-api-client/docs/AttributePositiveFilterAllOf.md rename to gooddata-api-client/docs/FlowOperationOutput.md index a272e79e3..47dca49d8 100644 --- a/gooddata-api-client/docs/AttributePositiveFilterAllOf.md +++ b/gooddata-api-client/docs/FlowOperationOutput.md @@ -1,11 +1,11 @@ -# AttributePositiveFilterAllOf +# FlowOperationOutput +The output of an operation. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**include** | **[str]** | | [optional] -**using** | **str** | | [optional] +**description** | **str** | What the operation produces. | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/FlowOperations.md b/gooddata-api-client/docs/FlowOperations.md new file mode 100644 index 000000000..8ed99ccd7 --- /dev/null +++ b/gooddata-api-client/docs/FlowOperations.md @@ -0,0 +1,13 @@ +# FlowOperations + +The operations that the transformations of a flow can run. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operations** | [**[FlowOperationDescriptor]**](FlowOperationDescriptor.md) | Available operations. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/FlowRequest.md b/gooddata-api-client/docs/FlowRequest.md new file mode 100644 index 000000000..a57eef409 --- /dev/null +++ b/gooddata-api-client/docs/FlowRequest.md @@ -0,0 +1,14 @@ +# FlowRequest + +A flow: named inputs and the transformations that run over them. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**inputs** | [**{str: (FlowInput,)}**](FlowInput.md) | Inputs of the flow by name. A transformation refers to an input by its name. | +**transformations** | [**[FlowTransformation]**](FlowTransformation.md) | Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input. | [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/FlowResultMetadata.md b/gooddata-api-client/docs/FlowResultMetadata.md new file mode 100644 index 000000000..93b50c0e3 --- /dev/null +++ b/gooddata-api-client/docs/FlowResultMetadata.md @@ -0,0 +1,15 @@ +# FlowResultMetadata + +Description of a flow result. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**columns** | [**[FlowColumn]**](FlowColumn.md) | Columns of the result, in order. | +**metadata** | **{str: (str,)}** | Metadata of the result, as the operations that produced it give them. | +**total_rows** | **int** | Number of rows in the result. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/FlowTablePaging.md b/gooddata-api-client/docs/FlowTablePaging.md new file mode 100644 index 000000000..67ebe3424 --- /dev/null +++ b/gooddata-api-client/docs/FlowTablePaging.md @@ -0,0 +1,18 @@ +# FlowTablePaging + +Position of a page in a table result. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**column_limit** | **int** | Maximum number of columns in the page. | +**column_offset** | **int** | Index of the first column of the page. | +**row_limit** | **int** | Maximum number of rows in the page. | +**row_offset** | **int** | Index of the first row of the page. | +**total_columns** | **int** | Number of columns in the result. | +**total_rows** | **int** | Number of rows in the result. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/FlowTableResult.md b/gooddata-api-client/docs/FlowTableResult.md new file mode 100644 index 000000000..4d417e2af --- /dev/null +++ b/gooddata-api-client/docs/FlowTableResult.md @@ -0,0 +1,15 @@ +# FlowTableResult + +A page of a table result. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**columns** | [**[FlowColumn]**](FlowColumn.md) | Columns of the page, in order. | +**data** | **[[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]** | Rows of the page. A row has one value for each column, in the order of the columns. | +**paging** | [**FlowTablePaging**](FlowTablePaging.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/FlowTransformation.md b/gooddata-api-client/docs/FlowTransformation.md new file mode 100644 index 000000000..e2724b55f --- /dev/null +++ b/gooddata-api-client/docs/FlowTransformation.md @@ -0,0 +1,16 @@ +# FlowTransformation + +One transformation of a flow: an operation that runs over its inputs. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | **str** | Name of the operation, as the operation catalog lists it. | +**id** | **str, none_type** | Identifier of the transformation. Give it when a later transformation refers to it. The identifier does not change the result. | [optional] +**input_refs** | **{str: (str,)}** | Inputs of the operation by name. Each one refers to a flow input or to an earlier transformation. The primary input is named data. When data is not given, it refers to the previous transformation, or to the only flow input for the first transformation. | [optional] +**parameters** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Parameters of the operation. They must match the parameter schema of the operation. | [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/ForecastConfig.md b/gooddata-api-client/docs/ForecastConfig.md deleted file mode 100644 index f302b7a0e..000000000 --- a/gooddata-api-client/docs/ForecastConfig.md +++ /dev/null @@ -1,15 +0,0 @@ -# ForecastConfig - -Forecast configuration. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**confidence_level** | **float** | Confidence interval boundary value. | -**forecast_period** | **int** | Number of future periods that should be forecasted | -**seasonal** | **bool** | Whether the input data is seasonal | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/FoundObjects.md b/gooddata-api-client/docs/FoundObjects.md deleted file mode 100644 index ffba42340..000000000 --- a/gooddata-api-client/docs/FoundObjects.md +++ /dev/null @@ -1,14 +0,0 @@ -# FoundObjects - -List of objects found by similarity search and post-processed by LLM. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**objects** | [**[SearchResultObject]**](SearchResultObject.md) | List of objects found with a similarity search. | -**reasoning** | **str** | DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/GenAiRankingFilter.md b/gooddata-api-client/docs/GenAiRankingFilter.md deleted file mode 100644 index 1c11c9027..000000000 --- a/gooddata-api-client/docs/GenAiRankingFilter.md +++ /dev/null @@ -1,15 +0,0 @@ -# GenAiRankingFilter - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**measures** | **[str]** | | -**operator** | **str** | | -**value** | **int** | | -**dimensionality** | **[str]** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/GenAiRankingFilterAllOf.md b/gooddata-api-client/docs/GenAiRankingFilterAllOf.md deleted file mode 100644 index 86aa7a0fa..000000000 --- a/gooddata-api-client/docs/GenAiRankingFilterAllOf.md +++ /dev/null @@ -1,15 +0,0 @@ -# GenAiRankingFilterAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dimensionality** | **[str]** | | [optional] -**measures** | **[str]** | | [optional] -**operator** | **str** | | [optional] -**value** | **int** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/GetAiLakeOperation200Response.md b/gooddata-api-client/docs/GetAiLakeOperation200Response.md index 8bbc39fb4..d7b04535a 100644 --- a/gooddata-api-client/docs/GetAiLakeOperation200Response.md +++ b/gooddata-api-client/docs/GetAiLakeOperation200Response.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **status** | **str** | | **result** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Operation-specific result payload, can be missing for operations like delete | [optional] **id** | **str** | Id of the operation | [optional] -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | [optional] +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | [optional] **error** | [**OperationError**](OperationError.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/HashDistributionConfig.md b/gooddata-api-client/docs/HashDistributionConfig.md deleted file mode 100644 index eb3021160..000000000 --- a/gooddata-api-client/docs/HashDistributionConfig.md +++ /dev/null @@ -1,15 +0,0 @@ -# HashDistributionConfig - -Hash-based distribution across buckets. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "hash" -**buckets** | **int** | Number of hash buckets. Defaults to 1. | [optional] -**columns** | **[str]** | Columns to distribute by. Defaults to first column. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ImageExportApi.md b/gooddata-api-client/docs/ImageExportApi.md index a08af2104..5a63d82b0 100644 --- a/gooddata-api-client/docs/ImageExportApi.md +++ b/gooddata-api-client/docs/ImageExportApi.md @@ -48,6 +48,7 @@ with gooddata_api_client.ApiClient() as api_client: "widget_ids_example", ], ) # ImageExportRequest | + 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: @@ -56,6 +57,15 @@ with gooddata_api_client.ApiClient() as api_client: pprint(api_response) except gooddata_api_client.ApiException as e: print("Exception when calling ImageExportApi->create_image_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create image export request + api_response = api_instance.create_image_export(workspace_id, image_export_request, x_gdc_debug=x_gdc_debug) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ImageExportApi->create_image_export: %s\n" % e) ``` @@ -65,6 +75,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **image_export_request** | [**ImageExportRequest**](ImageExportRequest.md)| | + **x_gdc_debug** | **bool**| | [optional] if omitted the server will use the default value of False ### Return type diff --git a/gooddata-api-client/docs/InsightWidgetDescriptor.md b/gooddata-api-client/docs/InsightWidgetDescriptor.md deleted file mode 100644 index be87d25df..000000000 --- a/gooddata-api-client/docs/InsightWidgetDescriptor.md +++ /dev/null @@ -1,18 +0,0 @@ -# InsightWidgetDescriptor - -Insight widget displaying a visualization. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**title** | **str** | Widget title as displayed on the dashboard. | -**visualization_id** | **str** | Visualization object ID referenced by this insight widget. | -**widget_id** | **str** | Widget object ID. | -**widget_type** | **str** | | defaults to "insight" -**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Filters currently applied to the dashboard. | [optional] -**result_id** | **str** | Signed result ID for this widget's cached execution result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/Instruction.md b/gooddata-api-client/docs/Instruction.md new file mode 100644 index 000000000..7db2ef4b3 --- /dev/null +++ b/gooddata-api-client/docs/Instruction.md @@ -0,0 +1,16 @@ +# Instruction + +Rule that an agent follows when answering. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **str** | The rule the agent follows when answering | +**strategy** | **str** | When an instruction is applied to a request | +**is_disabled** | **bool, none_type** | Whether the instruction is disabled | [optional] +**title** | **str, none_type** | Short name shown in the agent builder. | [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/Invitation.md b/gooddata-api-client/docs/Invitation.md new file mode 100644 index 000000000..5a4962967 --- /dev/null +++ b/gooddata-api-client/docs/Invitation.md @@ -0,0 +1,16 @@ +# Invitation + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**email** | **str** | | +**user_id** | **str** | | +**first_name** | **str** | | [optional] +**force_send** | **bool** | Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends) | [optional] +**last_name** | **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/JsonApiAgentInAttributes.md b/gooddata-api-client/docs/JsonApiAgentInAttributes.md index 5a5d4f947..e715dbad8 100644 --- a/gooddata-api-client/docs/JsonApiAgentInAttributes.md +++ b/gooddata-api-client/docs/JsonApiAgentInAttributes.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **custom_skills** | **[str], none_type** | | [optional] **description** | **str, none_type** | | [optional] **enabled** | **bool** | | [optional] +**instructions** | [**[JsonApiAgentInAttributesInstructionsInner], none_type**](JsonApiAgentInAttributesInstructionsInner.md) | Rules this agent follows when answering. | [optional] **is_preview** | **bool** | | [optional] **name** | **str, none_type** | | [optional] **personality** | **str, none_type** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAgentInAttributesInstructionsInner.md b/gooddata-api-client/docs/JsonApiAgentInAttributesInstructionsInner.md new file mode 100644 index 000000000..fcfa40e4b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAgentInAttributesInstructionsInner.md @@ -0,0 +1,16 @@ +# JsonApiAgentInAttributesInstructionsInner + +Rule that an agent follows when answering. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **str** | The rule the agent follows when answering | +**strategy** | **str** | When an instruction is applied to a request | +**is_disabled** | **bool, none_type** | Whether the instruction is disabled | [optional] +**title** | **str, none_type** | Short name shown in the agent builder. | [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/JsonApiAgentOutAttributes.md b/gooddata-api-client/docs/JsonApiAgentOutAttributes.md index 1f516b3d5..90bc60d45 100644 --- a/gooddata-api-client/docs/JsonApiAgentOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAgentOutAttributes.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **custom_skills** | **[str], none_type** | | [optional] **description** | **str, none_type** | | [optional] **enabled** | **bool** | | [optional] +**instructions** | [**[JsonApiAgentInAttributesInstructionsInner], none_type**](JsonApiAgentInAttributesInstructionsInner.md) | Rules this agent follows when answering. | [optional] **is_preview** | **bool** | | [optional] **modified_at** | **datetime** | | [optional] **name** | **str, none_type** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAgentOutDocument.md b/gooddata-api-client/docs/JsonApiAgentOutDocument.md index 0fafecc3f..5c96d8e37 100644 --- a/gooddata-api-client/docs/JsonApiAgentOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAgentOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiAgentOut**](JsonApiAgentOut.md) | | **included** | [**[JsonApiAgentOutIncludes]**](JsonApiAgentOutIncludes.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/JsonApiAgentOutDocumentMeta.md b/gooddata-api-client/docs/JsonApiAgentOutDocumentMeta.md new file mode 100644 index 000000000..5110a3f1a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAgentOutDocumentMeta.md @@ -0,0 +1,12 @@ +# JsonApiAgentOutDocumentMeta + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**restricted** | [**[RestrictedObject]**](RestrictedObject.md) | 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. | [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/JsonApiAgentOutListMeta.md b/gooddata-api-client/docs/JsonApiAgentOutListMeta.md index d436e1beb..b9c2d321a 100644 --- a/gooddata-api-client/docs/JsonApiAgentOutListMeta.md +++ b/gooddata-api-client/docs/JsonApiAgentOutListMeta.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **page** | [**PageMetadata**](PageMetadata.md) | | [optional] +**restricted** | [**[RestrictedObject]**](RestrictedObject.md) | 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. | [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/JsonApiAggregatedFactOutDocument.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md index c5efadc34..8c2afed20 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiAggregatedFactOut**](JsonApiAggregatedFactOut.md) | | **included** | [**[JsonApiAggregatedFactOutIncludes]**](JsonApiAggregatedFactOutIncludes.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/JsonApiAggregatedFactOutIncludes.md b/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md index 616ec982a..cbca2c527 100644 --- a/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAggregatedFactOutIncludes.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiFactOutRelationships**](JsonApiFactOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md index c4d31f1e7..2a02874e9 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiAnalyticalDashboardOut**](JsonApiAnalyticalDashboardOut.md) | | **included** | [**[JsonApiAnalyticalDashboardOutIncludes]**](JsonApiAnalyticalDashboardOutIncludes.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/JsonApiAnalyticalDashboardOutIncludes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md index d16e2c411..56406ddd6 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutIncludes.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md index 559b0e2db..d86bd1eed 100644 --- a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationships.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboards** | [**JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards**](JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md) | | [optional] **certified_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] +**computed_attributes** | [**JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes**](JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md) | | [optional] **created_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] **dashboard_plugins** | [**JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins**](JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md new file mode 100644 index 000000000..06b570a1b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md @@ -0,0 +1,12 @@ +# JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiComputedAttributeToManyLinkage**](JsonApiComputedAttributeToManyLinkage.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/JsonApiApiTokenOutList.md b/gooddata-api-client/docs/JsonApiApiTokenOutList.md index 0e296e733..69da0de35 100644 --- a/gooddata-api-client/docs/JsonApiApiTokenOutList.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiApiTokenOutWithLinks]**](JsonApiApiTokenOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/Filter.md b/gooddata-api-client/docs/JsonApiApiTokenOutListMeta.md similarity index 82% rename from gooddata-api-client/docs/Filter.md rename to gooddata-api-client/docs/JsonApiApiTokenOutListMeta.md index 736cbd494..f0718df18 100644 --- a/gooddata-api-client/docs/Filter.md +++ b/gooddata-api-client/docs/JsonApiApiTokenOutListMeta.md @@ -1,10 +1,10 @@ -# Filter +# JsonApiApiTokenOutListMeta -List of filters to be applied to the new visualization ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**page** | [**PageMetadata**](PageMetadata.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/JsonApiAttributeHierarchyOutDocument.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md index 51deaf3bd..3ffb92d1c 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiAttributeHierarchyOut**](JsonApiAttributeHierarchyOut.md) | | **included** | [**[JsonApiAttributeHierarchyOutIncludes]**](JsonApiAttributeHierarchyOutIncludes.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/JsonApiAttributeHierarchyOutIncludes.md b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md index 8b4d38fce..cdd67b62f 100644 --- a/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAttributeHierarchyOutIncludes.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiUserIdentifierOutAttributes**](JsonApiUserIdentifierOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeOutRelationships**](JsonApiAttributeOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **id** | **str** | API identifier of an object | [optional] diff --git a/gooddata-api-client/docs/JsonApiAttributeOut.md b/gooddata-api-client/docs/JsonApiAttributeOut.md index d767330b4..9116bf6ff 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOut.md +++ b/gooddata-api-client/docs/JsonApiAttributeOut.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "attribute" **attributes** | [**JsonApiAttributeOutAttributes**](JsonApiAttributeOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeOutRelationships**](JsonApiAttributeOutRelationships.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md b/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md index c429e67d3..f70fbb5c8 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutAttributes.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] +**conditional_formatting** | [**JsonApiAttributeOutAttributesConditionalFormatting**](JsonApiAttributeOutAttributesConditionalFormatting.md) | | [optional] **description** | **str** | | [optional] **granularity** | **str** | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAttributeOutAttributesConditionalFormatting.md b/gooddata-api-client/docs/JsonApiAttributeOutAttributesConditionalFormatting.md new file mode 100644 index 000000000..d3a4e4f57 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAttributeOutAttributesConditionalFormatting.md @@ -0,0 +1,14 @@ +# JsonApiAttributeOutAttributesConditionalFormatting + +Conditional formatting applied to table columns that render this attribute. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conditions** | [**[ConditionalFormattingCondition]**](ConditionalFormattingCondition.md) | Conditions evaluated in order; the first match wins. | +**enabled** | **bool** | Whether the conditions are applied when rendering. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiAttributeOutDocument.md b/gooddata-api-client/docs/JsonApiAttributeOutDocument.md index 5b16433f1..73dc5f17f 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiAttributeOut**](JsonApiAttributeOut.md) | | **included** | [**[JsonApiAttributeOutIncludes]**](JsonApiAttributeOutIncludes.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/JsonApiAttributeOutIncludes.md b/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md index d3d4269cd..d56619d73 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutIncludes.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAttributeOutMeta.md b/gooddata-api-client/docs/JsonApiAttributeOutMeta.md new file mode 100644 index 000000000..110ec7dc0 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiAttributeOutMeta.md @@ -0,0 +1,13 @@ +# JsonApiAttributeOutMeta + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**origin** | [**JsonApiAggregatedFactOutMetaOrigin**](JsonApiAggregatedFactOutMetaOrigin.md) | | [optional] +**permissions** | **[str]** | List of valid permissions for a logged-in user. | [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/JsonApiAttributeOutWithLinks.md b/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md index 3ee930c71..b5ce9d296 100644 --- a/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiAttributeOutWithLinks.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "attribute" **attributes** | [**JsonApiAttributeOutAttributes**](JsonApiAttributeOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiAttributeOutRelationships**](JsonApiAttributeOutRelationships.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] diff --git a/gooddata-api-client/docs/JsonApiAttributePatchAttributes.md b/gooddata-api-client/docs/JsonApiAttributePatchAttributes.md index aa6df7f2a..d1af60210 100644 --- a/gooddata-api-client/docs/JsonApiAttributePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiAttributePatchAttributes.md @@ -4,6 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**conditional_formatting** | [**JsonApiAttributeOutAttributesConditionalFormatting**](JsonApiAttributeOutAttributesConditionalFormatting.md) | | [optional] **description** | **str** | | [optional] **tags** | **[str]** | | [optional] **title** | **str** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md b/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md index 743bb8a3e..f01424f7e 100644 --- a/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md +++ b/gooddata-api-client/docs/JsonApiAutomationInAttributesAlert.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **condition** | [**AlertCondition**](AlertCondition.md) | | **execution** | [**AlertAfm**](AlertAfm.md) | | **interval** | **str** | Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR. | [optional] +**settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] **trigger** | **str** | Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. | [optional] if omitted the server will use the default value of "ALWAYS" **any string name** | **bool, 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/JsonApiAutomationOutDocument.md b/gooddata-api-client/docs/JsonApiAutomationOutDocument.md index 080adccd4..02507749e 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutDocument.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiAutomationOut**](JsonApiAutomationOut.md) | | **included** | [**[JsonApiAutomationOutIncludes]**](JsonApiAutomationOutIncludes.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/JsonApiAutomationOutIncludes.md b/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md index 2bdac1bc6..4d9d19aad 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutIncludes.md @@ -4,12 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiAgentInRelationships**](JsonApiAgentInRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiUserIdentifierOutAttributes**](JsonApiUserIdentifierOutAttributes.md) | | [optional] +**attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "userIdentifier" +**type** | **str** | Object type | [optional] if omitted the server will use the default value of "visualizationObject" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md index 7f62f6446..59575e7e4 100644 --- a/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationships.md @@ -5,12 +5,19 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **analytical_dashboard** | [**JsonApiAutomationInRelationshipsAnalyticalDashboard**](JsonApiAutomationInRelationshipsAnalyticalDashboard.md) | | [optional] +**analytical_dashboards** | [**JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards**](JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards.md) | | [optional] +**attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] **automation_results** | [**JsonApiAutomationOutRelationshipsAutomationResults**](JsonApiAutomationOutRelationshipsAutomationResults.md) | | [optional] +**computed_attributes** | [**JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes**](JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md) | | [optional] **created_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] **export_definitions** | [**JsonApiAutomationInRelationshipsExportDefinitions**](JsonApiAutomationInRelationshipsExportDefinitions.md) | | [optional] +**facts** | [**JsonApiAutomationOutRelationshipsFacts**](JsonApiAutomationOutRelationshipsFacts.md) | | [optional] +**labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] +**metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] **modified_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] **notification_channel** | [**JsonApiAutomationInRelationshipsNotificationChannel**](JsonApiAutomationInRelationshipsNotificationChannel.md) | | [optional] **recipients** | [**JsonApiAutomationInRelationshipsRecipients**](JsonApiAutomationInRelationshipsRecipients.md) | | [optional] +**visualization_objects** | [**JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects**](JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects.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/JsonApiDatasetOutRelationshipsFacts.md b/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsFacts.md similarity index 92% rename from gooddata-api-client/docs/JsonApiDatasetOutRelationshipsFacts.md rename to gooddata-api-client/docs/JsonApiAutomationOutRelationshipsFacts.md index 3393fb6f5..c0f30364b 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutRelationshipsFacts.md +++ b/gooddata-api-client/docs/JsonApiAutomationOutRelationshipsFacts.md @@ -1,4 +1,4 @@ -# JsonApiDatasetOutRelationshipsFacts +# JsonApiAutomationOutRelationshipsFacts ## Properties diff --git a/gooddata-api-client/docs/JsonApiColorPaletteOutList.md b/gooddata-api-client/docs/JsonApiColorPaletteOutList.md index df4900523..c4c1191ce 100644 --- a/gooddata-api-client/docs/JsonApiColorPaletteOutList.md +++ b/gooddata-api-client/docs/JsonApiColorPaletteOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiColorPaletteOutWithLinks]**](JsonApiColorPaletteOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiComputedAttributeIn.md b/gooddata-api-client/docs/JsonApiComputedAttributeIn.md new file mode 100644 index 000000000..23670e99c --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeIn.md @@ -0,0 +1,15 @@ +# JsonApiComputedAttributeIn + +JSON:API representation of computedAttribute entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiComputedAttributeInAttributes**](JsonApiComputedAttributeInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "computedAttribute" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiComputedAttributeInAttributes.md b/gooddata-api-client/docs/JsonApiComputedAttributeInAttributes.md new file mode 100644 index 000000000..f8d32c634 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeInAttributes.md @@ -0,0 +1,22 @@ +# JsonApiComputedAttributeInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiComputedAttributeInAttributesContent**](JsonApiComputedAttributeInAttributesContent.md) | | +**are_relations_valid** | **bool** | | [optional] +**data_type** | **str** | | [optional] +**description** | **str** | | [optional] +**is_hidden** | **bool** | | [optional] +**is_nullable** | **bool** | | [optional] +**locale** | **str** | | [optional] +**null_value** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**value_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/JsonApiMetricInAttributesContent.md b/gooddata-api-client/docs/JsonApiComputedAttributeInAttributesContent.md similarity index 96% rename from gooddata-api-client/docs/JsonApiMetricInAttributesContent.md rename to gooddata-api-client/docs/JsonApiComputedAttributeInAttributesContent.md index 62406b377..b8d608e06 100644 --- a/gooddata-api-client/docs/JsonApiMetricInAttributesContent.md +++ b/gooddata-api-client/docs/JsonApiComputedAttributeInAttributesContent.md @@ -1,4 +1,4 @@ -# JsonApiMetricInAttributesContent +# JsonApiComputedAttributeInAttributesContent ## Properties diff --git a/gooddata-api-client/docs/AnomalyDetectionConfig.md b/gooddata-api-client/docs/JsonApiComputedAttributeInDocument.md similarity index 79% rename from gooddata-api-client/docs/AnomalyDetectionConfig.md rename to gooddata-api-client/docs/JsonApiComputedAttributeInDocument.md index 63b7eaeb5..bd50dca8c 100644 --- a/gooddata-api-client/docs/AnomalyDetectionConfig.md +++ b/gooddata-api-client/docs/JsonApiComputedAttributeInDocument.md @@ -1,11 +1,10 @@ -# AnomalyDetectionConfig +# JsonApiComputedAttributeInDocument -Anomaly detection configuration. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sensitivity** | **str** | Outlier sensitivity level. | +**data** | [**JsonApiComputedAttributeIn**](JsonApiComputedAttributeIn.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/ResolvedLlm.md b/gooddata-api-client/docs/JsonApiComputedAttributeLinkage.md similarity index 76% rename from gooddata-api-client/docs/ResolvedLlm.md rename to gooddata-api-client/docs/JsonApiComputedAttributeLinkage.md index c0966bf7c..f52be85e8 100644 --- a/gooddata-api-client/docs/ResolvedLlm.md +++ b/gooddata-api-client/docs/JsonApiComputedAttributeLinkage.md @@ -1,12 +1,12 @@ -# ResolvedLlm +# JsonApiComputedAttributeLinkage -The resolved LLM configuration, or null if none is configured. +The \\\"type\\\" and \\\"id\\\" to non-empty members. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | -**title** | **str** | | +**type** | **str** | | defaults to "computedAttribute" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiComputedAttributeOut.md b/gooddata-api-client/docs/JsonApiComputedAttributeOut.md new file mode 100644 index 000000000..577c5ee1e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOut.md @@ -0,0 +1,17 @@ +# JsonApiComputedAttributeOut + +JSON:API representation of computedAttribute entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiComputedAttributeOutAttributes**](JsonApiComputedAttributeOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "computedAttribute" +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.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/JsonApiComputedAttributeOutAttributes.md b/gooddata-api-client/docs/JsonApiComputedAttributeOutAttributes.md new file mode 100644 index 000000000..7dcca9f73 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOutAttributes.md @@ -0,0 +1,27 @@ +# JsonApiComputedAttributeOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | [**JsonApiComputedAttributeInAttributesContent**](JsonApiComputedAttributeInAttributesContent.md) | | +**are_relations_valid** | **bool** | | [optional] +**certification** | **str** | Certification status of the entity. | [optional] if omitted the server will use the default value of "CERTIFIED" +**certification_message** | **str, none_type** | Optional message associated with the certification. | [optional] +**certified_at** | **datetime, none_type** | Time when the certification was set. | [optional] +**created_at** | **datetime, none_type** | Time of the entity creation. | [optional] +**data_type** | **str** | | [optional] +**description** | **str** | | [optional] +**is_hidden** | **bool** | | [optional] +**is_nullable** | **bool** | | [optional] +**locale** | **str** | | [optional] +**modified_at** | **datetime, none_type** | Time of the last entity modification. | [optional] +**null_value** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**value_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/JsonApiListDocumentPipeTableSummary.md b/gooddata-api-client/docs/JsonApiComputedAttributeOutDocument.md similarity index 52% rename from gooddata-api-client/docs/JsonApiListDocumentPipeTableSummary.md rename to gooddata-api-client/docs/JsonApiComputedAttributeOutDocument.md index 160470d6d..305765c8b 100644 --- a/gooddata-api-client/docs/JsonApiListDocumentPipeTableSummary.md +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOutDocument.md @@ -1,13 +1,13 @@ -# JsonApiListDocumentPipeTableSummary +# JsonApiComputedAttributeOutDocument -JSON:API-compatible list response envelope ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**data** | [**[JsonApiItemPipeTableSummary]**](JsonApiItemPipeTableSummary.md) | Array of resource items | -**links** | [**JsonApiListLinks**](JsonApiListLinks.md) | | -**meta** | [**JsonApiListMeta**](JsonApiListMeta.md) | | [optional] +**data** | [**JsonApiComputedAttributeOut**](JsonApiComputedAttributeOut.md) | | +**included** | [**[JsonApiComputedAttributeOutIncludes]**](JsonApiComputedAttributeOutIncludes.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/JsonApiMetricOutIncludes.md b/gooddata-api-client/docs/JsonApiComputedAttributeOutIncludes.md similarity index 96% rename from gooddata-api-client/docs/JsonApiMetricOutIncludes.md rename to gooddata-api-client/docs/JsonApiComputedAttributeOutIncludes.md index f1d966152..63e97cd04 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOutIncludes.md @@ -1,4 +1,4 @@ -# JsonApiMetricOutIncludes +# JsonApiComputedAttributeOutIncludes ## Properties diff --git a/gooddata-api-client/docs/JsonApiComputedAttributeOutList.md b/gooddata-api-client/docs/JsonApiComputedAttributeOutList.md new file mode 100644 index 000000000..aee4c9067 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOutList.md @@ -0,0 +1,16 @@ +# JsonApiComputedAttributeOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiComputedAttributeOutWithLinks]**](JsonApiComputedAttributeOutWithLinks.md) | | +**included** | [**[JsonApiComputedAttributeOutIncludes]**](JsonApiComputedAttributeOutIncludes.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/JsonApiMetricOutRelationships.md b/gooddata-api-client/docs/JsonApiComputedAttributeOutRelationships.md similarity index 82% rename from gooddata-api-client/docs/JsonApiMetricOutRelationships.md rename to gooddata-api-client/docs/JsonApiComputedAttributeOutRelationships.md index 38355d4d4..81881c5fc 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOutRelationships.md @@ -1,4 +1,4 @@ -# JsonApiMetricOutRelationships +# JsonApiComputedAttributeOutRelationships ## Properties @@ -6,9 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] **certified_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] +**computed_attributes** | [**JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes**](JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md) | | [optional] **created_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] -**facts** | [**JsonApiDatasetOutRelationshipsFacts**](JsonApiDatasetOutRelationshipsFacts.md) | | [optional] +**facts** | [**JsonApiAutomationOutRelationshipsFacts**](JsonApiAutomationOutRelationshipsFacts.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] **modified_by** | [**JsonApiAgentOutRelationshipsCreatedBy**](JsonApiAgentOutRelationshipsCreatedBy.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiComputedAttributeOutWithLinks.md b/gooddata-api-client/docs/JsonApiComputedAttributeOutWithLinks.md new file mode 100644 index 000000000..c88e11f09 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiComputedAttributeOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiComputedAttributeOutAttributes**](JsonApiComputedAttributeOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "computedAttribute" +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.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/JsonApiComputedAttributePatch.md b/gooddata-api-client/docs/JsonApiComputedAttributePatch.md new file mode 100644 index 000000000..537915881 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributePatch.md @@ -0,0 +1,15 @@ +# JsonApiComputedAttributePatch + +JSON:API representation of patching computedAttribute entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiComputedAttributePatchAttributes**](JsonApiComputedAttributePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "computedAttribute" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiComputedAttributePatchAttributes.md b/gooddata-api-client/docs/JsonApiComputedAttributePatchAttributes.md new file mode 100644 index 000000000..22dc5e941 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributePatchAttributes.md @@ -0,0 +1,22 @@ +# JsonApiComputedAttributePatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | [**JsonApiComputedAttributeInAttributesContent**](JsonApiComputedAttributeInAttributesContent.md) | | [optional] +**data_type** | **str** | | [optional] +**description** | **str** | | [optional] +**is_hidden** | **bool** | | [optional] +**is_nullable** | **bool** | | [optional] +**locale** | **str** | | [optional] +**null_value** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**value_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/JsonApiComputedAttributePatchDocument.md b/gooddata-api-client/docs/JsonApiComputedAttributePatchDocument.md new file mode 100644 index 000000000..879689a0e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiComputedAttributePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiComputedAttributePatch**](JsonApiComputedAttributePatch.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/JsonApiComputedAttributePostOptionalId.md b/gooddata-api-client/docs/JsonApiComputedAttributePostOptionalId.md new file mode 100644 index 000000000..9c9e7742a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributePostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiComputedAttributePostOptionalId + +JSON:API representation of computedAttribute entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiComputedAttributeInAttributes**](JsonApiComputedAttributeInAttributes.md) | | +**type** | **str** | Object type | defaults to "computedAttribute" +**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/JsonApiComputedAttributePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiComputedAttributePostOptionalIdDocument.md new file mode 100644 index 000000000..2be953fc3 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributePostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiComputedAttributePostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiComputedAttributePostOptionalId**](JsonApiComputedAttributePostOptionalId.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/JsonApiComputedAttributeToManyLinkage.md b/gooddata-api-client/docs/JsonApiComputedAttributeToManyLinkage.md new file mode 100644 index 000000000..7b67f14d1 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiComputedAttributeToManyLinkage.md @@ -0,0 +1,12 @@ +# JsonApiComputedAttributeToManyLinkage + +References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**value** | [**[JsonApiComputedAttributeLinkage]**](JsonApiComputedAttributeLinkage.md) | References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object. | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md b/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md index 75a9a7cbd..c13ac905a 100644 --- a/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md +++ b/gooddata-api-client/docs/JsonApiCspDirectiveOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiCspDirectiveOutWithLinks]**](JsonApiCspDirectiveOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiCustomApplicationSettingOutList.md b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md index c54c0646a..a0301884d 100644 --- a/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiCustomApplicationSettingOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiCustomApplicationSettingOutWithLinks]**](JsonApiCustomApplicationSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiCustomGeoCollectionOutList.md b/gooddata-api-client/docs/JsonApiCustomGeoCollectionOutList.md index 321f94b87..9770b9310 100644 --- a/gooddata-api-client/docs/JsonApiCustomGeoCollectionOutList.md +++ b/gooddata-api-client/docs/JsonApiCustomGeoCollectionOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiCustomGeoCollectionOutWithLinks]**](JsonApiCustomGeoCollectionOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiCustomUserApplicationSettingOutList.md b/gooddata-api-client/docs/JsonApiCustomUserApplicationSettingOutList.md index 3382bd20d..61fabc46f 100644 --- a/gooddata-api-client/docs/JsonApiCustomUserApplicationSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiCustomUserApplicationSettingOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiCustomUserApplicationSettingOutWithLinks]**](JsonApiCustomUserApplicationSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiDashboardPluginOutDocument.md b/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md index 3f8a0f5d8..febdb8cf4 100644 --- a/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md +++ b/gooddata-api-client/docs/JsonApiDashboardPluginOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiDashboardPluginOut**](JsonApiDashboardPluginOut.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/JsonApiDataSourceIdentifierOutList.md b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md index 827dcd544..28a504843 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md +++ b/gooddata-api-client/docs/JsonApiDataSourceIdentifierOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiDataSourceIdentifierOutWithLinks]**](JsonApiDataSourceIdentifierOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiDataSourceInAttributes.md b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md index 81e8ac286..5e346d392 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceInAttributes.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **client_secret** | **str, none_type** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **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] **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 b841a470b..3f5598edd 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutAttributes.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **date_time_semantics** | **str, none_type** | Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this. | [optional] **decoded_parameters** | [**[JsonApiDataSourceInAttributesParametersInner], none_type**](JsonApiDataSourceInAttributesParametersInner.md) | Decoded parameters to be used when connecting to the database providing the data for the data source. | [optional] +**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] **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/JsonApiDataSourceOutList.md b/gooddata-api-client/docs/JsonApiDataSourceOutList.md index 7616697a8..221f0f42d 100644 --- a/gooddata-api-client/docs/JsonApiDataSourceOutList.md +++ b/gooddata-api-client/docs/JsonApiDataSourceOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiDataSourceOutWithLinks]**](JsonApiDataSourceOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiDataSourcePatchAttributes.md b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md index 8713bafb0..238fa4e1d 100644 --- a/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiDataSourcePatchAttributes.md @@ -11,6 +11,7 @@ Name | Type | Description | Notes **client_id** | **str, none_type** | The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **client_secret** | **str, none_type** | The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account). | [optional] **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] **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/JsonApiDatasetOutDocument.md b/gooddata-api-client/docs/JsonApiDatasetOutDocument.md index ede30b1c5..70545e409 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutDocument.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiDatasetOut**](JsonApiDatasetOut.md) | | **included** | [**[JsonApiDatasetOutIncludes]**](JsonApiDatasetOutIncludes.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/JsonApiDatasetOutRelationships.md b/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md index f88ecb21e..35f9e11fa 100644 --- a/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiDatasetOutRelationships.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **aggregated_facts** | [**JsonApiDatasetOutRelationshipsAggregatedFacts**](JsonApiDatasetOutRelationshipsAggregatedFacts.md) | | [optional] **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] -**facts** | [**JsonApiDatasetOutRelationshipsFacts**](JsonApiDatasetOutRelationshipsFacts.md) | | [optional] +**facts** | [**JsonApiAutomationOutRelationshipsFacts**](JsonApiAutomationOutRelationshipsFacts.md) | | [optional] **references** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] **workspace_data_filters** | [**JsonApiDatasetOutRelationshipsWorkspaceDataFilters**](JsonApiDatasetOutRelationshipsWorkspaceDataFilters.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiDatasetPatch.md b/gooddata-api-client/docs/JsonApiDatasetPatch.md index b3d2abd36..e272d8143 100644 --- a/gooddata-api-client/docs/JsonApiDatasetPatch.md +++ b/gooddata-api-client/docs/JsonApiDatasetPatch.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "dataset" -**attributes** | [**JsonApiAttributePatchAttributes**](JsonApiAttributePatchAttributes.md) | | [optional] +**attributes** | [**JsonApiDatasetPatchAttributes**](JsonApiDatasetPatchAttributes.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/JsonApiDatasetPatchAttributes.md b/gooddata-api-client/docs/JsonApiDatasetPatchAttributes.md new file mode 100644 index 000000000..c007f6b1b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiDatasetPatchAttributes.md @@ -0,0 +1,14 @@ +# JsonApiDatasetPatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | | [optional] +**tags** | **[str]** | | [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/JsonApiDocumentPipeTable.md b/gooddata-api-client/docs/JsonApiDocumentPipeTable.md deleted file mode 100644 index 882d7491b..000000000 --- a/gooddata-api-client/docs/JsonApiDocumentPipeTable.md +++ /dev/null @@ -1,14 +0,0 @@ -# JsonApiDocumentPipeTable - -JSON:API-compatible single-resource response envelope - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**JsonApiItemPipeTable**](JsonApiItemPipeTable.md) | | -**links** | [**JsonApiListLinks**](JsonApiListLinks.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/JsonApiEntitlementOutList.md b/gooddata-api-client/docs/JsonApiEntitlementOutList.md index 5e41b5d4d..90e5c7af1 100644 --- a/gooddata-api-client/docs/JsonApiEntitlementOutList.md +++ b/gooddata-api-client/docs/JsonApiEntitlementOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiEntitlementOutWithLinks]**](JsonApiEntitlementOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiExportDefinitionInAttributesRequestPayload.md b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md index 1337fc379..ecf364f5c 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionInAttributesRequestPayload.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **metadata** | [**JsonNode**](JsonNode.md) | | [optional] **timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] +**conditional_formatting** | [**ConditionalFormatting**](ConditionalFormatting.md) | | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] **execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md index 5110ebbc7..dc8cd88a6 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiExportDefinitionOut**](JsonApiExportDefinitionOut.md) | | **included** | [**[JsonApiExportDefinitionOutIncludes]**](JsonApiExportDefinitionOutIncludes.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/JsonApiExportDefinitionOutIncludes.md b/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md index 08508f9d9..8347fac01 100644 --- a/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiExportDefinitionOutIncludes.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] diff --git a/gooddata-api-client/docs/JsonApiExportTemplateOutList.md b/gooddata-api-client/docs/JsonApiExportTemplateOutList.md index f27eb1797..4324f75b6 100644 --- a/gooddata-api-client/docs/JsonApiExportTemplateOutList.md +++ b/gooddata-api-client/docs/JsonApiExportTemplateOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiExportTemplateOutWithLinks]**](JsonApiExportTemplateOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiFactOut.md b/gooddata-api-client/docs/JsonApiFactOut.md index d2a72e499..ce466ff97 100644 --- a/gooddata-api-client/docs/JsonApiFactOut.md +++ b/gooddata-api-client/docs/JsonApiFactOut.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "fact" **attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiFactOutRelationships**](JsonApiFactOutRelationships.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiFactOutDocument.md b/gooddata-api-client/docs/JsonApiFactOutDocument.md index 72447c2f6..f9ba52737 100644 --- a/gooddata-api-client/docs/JsonApiFactOutDocument.md +++ b/gooddata-api-client/docs/JsonApiFactOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiFactOut**](JsonApiFactOut.md) | | **included** | [**[JsonApiDatasetOutWithLinks]**](JsonApiDatasetOutWithLinks.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/JsonApiFactOutWithLinks.md b/gooddata-api-client/docs/JsonApiFactOutWithLinks.md index 7d0c00e9b..f14d34a97 100644 --- a/gooddata-api-client/docs/JsonApiFactOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiFactOutWithLinks.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "fact" **attributes** | [**JsonApiFactOutAttributes**](JsonApiFactOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiFactOutRelationships**](JsonApiFactOutRelationships.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] diff --git a/gooddata-api-client/docs/JsonApiFactPatch.md b/gooddata-api-client/docs/JsonApiFactPatch.md index 28ddaddc5..f8f46e020 100644 --- a/gooddata-api-client/docs/JsonApiFactPatch.md +++ b/gooddata-api-client/docs/JsonApiFactPatch.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "fact" -**attributes** | [**JsonApiAttributePatchAttributes**](JsonApiAttributePatchAttributes.md) | | [optional] +**attributes** | [**JsonApiDatasetPatchAttributes**](JsonApiDatasetPatchAttributes.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/JsonApiFilterContextOutDocument.md b/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md index f1dbb76cc..0281b2f65 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiFilterContextOut**](JsonApiFilterContextOut.md) | | **included** | [**[JsonApiFilterContextOutIncludes]**](JsonApiFilterContextOutIncludes.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/JsonApiFilterContextOutIncludes.md b/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md index a88d58f2d..fa3f2a5db 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutIncludes.md @@ -4,12 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] -**attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] +**attributes** | [**JsonApiMetricOutAttributes**](JsonApiMetricOutAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] -**type** | **str** | Object type | [optional] if omitted the server will use the default value of "label" +**type** | **str** | Object type | [optional] if omitted the server will use the default value of "metric" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md b/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md index a241f25c2..b78b8b2c7 100644 --- a/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiFilterContextOutRelationships.md @@ -5,8 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] +**computed_attributes** | [**JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes**](JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] +**facts** | [**JsonApiAutomationOutRelationshipsFacts**](JsonApiAutomationOutRelationshipsFacts.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] +**metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.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/JsonApiFilterViewOutDocument.md b/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md index db60b2251..b9929ffed 100644 --- a/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md +++ b/gooddata-api-client/docs/JsonApiFilterViewOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiFilterViewOut**](JsonApiFilterViewOut.md) | | **included** | [**[JsonApiFilterViewOutIncludes]**](JsonApiFilterViewOutIncludes.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/JsonApiFiscalCalendarOutList.md b/gooddata-api-client/docs/JsonApiFiscalCalendarOutList.md index 40115da1a..00b834060 100644 --- a/gooddata-api-client/docs/JsonApiFiscalCalendarOutList.md +++ b/gooddata-api-client/docs/JsonApiFiscalCalendarOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiFiscalCalendarOutWithLinks]**](JsonApiFiscalCalendarOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiIdentityProviderOutList.md b/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md index 66ff40ca4..263cbd0af 100644 --- a/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md +++ b/gooddata-api-client/docs/JsonApiIdentityProviderOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiIdentityProviderOutWithLinks]**](JsonApiIdentityProviderOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiIpAllowlistPolicyOutDocument.md b/gooddata-api-client/docs/JsonApiIpAllowlistPolicyOutDocument.md index 59a6ee8a5..cfb37c246 100644 --- a/gooddata-api-client/docs/JsonApiIpAllowlistPolicyOutDocument.md +++ b/gooddata-api-client/docs/JsonApiIpAllowlistPolicyOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiIpAllowlistPolicyOut**](JsonApiIpAllowlistPolicyOut.md) | | **included** | [**[JsonApiIpAllowlistPolicyOutIncludes]**](JsonApiIpAllowlistPolicyOutIncludes.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/JsonApiItemPipeTable.md b/gooddata-api-client/docs/JsonApiItemPipeTable.md deleted file mode 100644 index 6f61e4b2e..000000000 --- a/gooddata-api-client/docs/JsonApiItemPipeTable.md +++ /dev/null @@ -1,15 +0,0 @@ -# JsonApiItemPipeTable - -A single JSON:API resource item - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**attributes** | [**PipeTable**](PipeTable.md) | | -**id** | **str** | Resource identifier | -**type** | **str** | Resource type | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/JsonApiJwkOutList.md b/gooddata-api-client/docs/JsonApiJwkOutList.md index ecb3e549f..557e58613 100644 --- a/gooddata-api-client/docs/JsonApiJwkOutList.md +++ b/gooddata-api-client/docs/JsonApiJwkOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiJwkOutWithLinks]**](JsonApiJwkOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiKnowledgeRecommendationOutDocument.md b/gooddata-api-client/docs/JsonApiKnowledgeRecommendationOutDocument.md index 2dffd6951..5ac9279d7 100644 --- a/gooddata-api-client/docs/JsonApiKnowledgeRecommendationOutDocument.md +++ b/gooddata-api-client/docs/JsonApiKnowledgeRecommendationOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiKnowledgeRecommendationOut**](JsonApiKnowledgeRecommendationOut.md) | | **included** | [**[JsonApiKnowledgeRecommendationOutIncludes]**](JsonApiKnowledgeRecommendationOutIncludes.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/JsonApiKnowledgeRecommendationOutIncludes.md b/gooddata-api-client/docs/JsonApiKnowledgeRecommendationOutIncludes.md index 9b4bcbdc7..2fb94cad3 100644 --- a/gooddata-api-client/docs/JsonApiKnowledgeRecommendationOutIncludes.md +++ b/gooddata-api-client/docs/JsonApiKnowledgeRecommendationOutIncludes.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **attributes** | [**JsonApiMetricOutAttributes**](JsonApiMetricOutAttributes.md) | | [optional] **id** | **str** | API identifier of an object | [optional] diff --git a/gooddata-api-client/docs/JsonApiLabelOut.md b/gooddata-api-client/docs/JsonApiLabelOut.md index edf3a5754..ff29960ee 100644 --- a/gooddata-api-client/docs/JsonApiLabelOut.md +++ b/gooddata-api-client/docs/JsonApiLabelOut.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "label" **attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiLabelOutAttributes.md b/gooddata-api-client/docs/JsonApiLabelOutAttributes.md index 58ca9f48f..ee07119c0 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiLabelOutAttributes.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] +**conditional_formatting** | [**JsonApiLabelOutAttributesConditionalFormatting**](JsonApiLabelOutAttributesConditionalFormatting.md) | | [optional] **description** | **str** | | [optional] **geo_area_config** | [**JsonApiLabelOutAttributesGeoAreaConfig**](JsonApiLabelOutAttributesGeoAreaConfig.md) | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiLabelOutAttributesConditionalFormatting.md b/gooddata-api-client/docs/JsonApiLabelOutAttributesConditionalFormatting.md new file mode 100644 index 000000000..2836b10e4 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiLabelOutAttributesConditionalFormatting.md @@ -0,0 +1,14 @@ +# JsonApiLabelOutAttributesConditionalFormatting + +Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conditions** | [**[ConditionalFormattingCondition]**](ConditionalFormattingCondition.md) | Conditions evaluated in order; the first match wins. | +**enabled** | **bool** | Whether the conditions are applied when rendering. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiLabelOutDocument.md b/gooddata-api-client/docs/JsonApiLabelOutDocument.md index 4ec6bb577..532a4296e 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutDocument.md +++ b/gooddata-api-client/docs/JsonApiLabelOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiLabelOut**](JsonApiLabelOut.md) | | **included** | [**[JsonApiAttributeOutWithLinks]**](JsonApiAttributeOutWithLinks.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/JsonApiLabelOutWithLinks.md b/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md index 2ae685a53..b52a2693e 100644 --- a/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiLabelOutWithLinks.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "label" **attributes** | [**JsonApiLabelOutAttributes**](JsonApiLabelOutAttributes.md) | | [optional] -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] **relationships** | [**JsonApiLabelOutRelationships**](JsonApiLabelOutRelationships.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] diff --git a/gooddata-api-client/docs/JsonApiLabelPatch.md b/gooddata-api-client/docs/JsonApiLabelPatch.md index 6ae8bbf2d..b5ea92cdd 100644 --- a/gooddata-api-client/docs/JsonApiLabelPatch.md +++ b/gooddata-api-client/docs/JsonApiLabelPatch.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "label" -**attributes** | [**JsonApiAttributePatchAttributes**](JsonApiAttributePatchAttributes.md) | | [optional] +**attributes** | [**JsonApiLabelPatchAttributes**](JsonApiLabelPatchAttributes.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/PrimaryKeyConfig.md b/gooddata-api-client/docs/JsonApiLabelPatchAttributes.md similarity index 64% rename from gooddata-api-client/docs/PrimaryKeyConfig.md rename to gooddata-api-client/docs/JsonApiLabelPatchAttributes.md index cdbeadb73..6e6355196 100644 --- a/gooddata-api-client/docs/PrimaryKeyConfig.md +++ b/gooddata-api-client/docs/JsonApiLabelPatchAttributes.md @@ -1,12 +1,13 @@ -# PrimaryKeyConfig +# JsonApiLabelPatchAttributes -Primary key model — enforces uniqueness, replaces on conflict. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "primary" -**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] +**conditional_formatting** | [**JsonApiLabelOutAttributesConditionalFormatting**](JsonApiLabelOutAttributesConditionalFormatting.md) | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [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/JsonApiLlmProviderOutList.md b/gooddata-api-client/docs/JsonApiLlmProviderOutList.md index a3107afb9..a515c42bd 100644 --- a/gooddata-api-client/docs/JsonApiLlmProviderOutList.md +++ b/gooddata-api-client/docs/JsonApiLlmProviderOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiLlmProviderOutWithLinks]**](JsonApiLlmProviderOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiMemoryItemOutDocument.md b/gooddata-api-client/docs/JsonApiMemoryItemOutDocument.md index e4c0e3b34..14438ae7a 100644 --- a/gooddata-api-client/docs/JsonApiMemoryItemOutDocument.md +++ b/gooddata-api-client/docs/JsonApiMemoryItemOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiMemoryItemOut**](JsonApiMemoryItemOut.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/JsonApiMetricInAttributes.md b/gooddata-api-client/docs/JsonApiMetricInAttributes.md index 7ed399db7..26a9c7900 100644 --- a/gooddata-api-client/docs/JsonApiMetricInAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricInAttributes.md @@ -4,8 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | +**content** | [**JsonApiComputedAttributeInAttributesContent**](JsonApiComputedAttributeInAttributesContent.md) | | **are_relations_valid** | **bool** | | [optional] +**conditional_formatting** | [**JsonApiMetricInAttributesConditionalFormatting**](JsonApiMetricInAttributesConditionalFormatting.md) | | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] **is_hidden_from_kda** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiMetricInAttributesConditionalFormatting.md b/gooddata-api-client/docs/JsonApiMetricInAttributesConditionalFormatting.md new file mode 100644 index 000000000..9d38b5c13 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiMetricInAttributesConditionalFormatting.md @@ -0,0 +1,14 @@ +# JsonApiMetricInAttributesConditionalFormatting + +Conditional formatting inherited by every table column that renders this metric. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conditions** | [**[ConditionalFormattingCondition]**](ConditionalFormattingCondition.md) | Conditions evaluated in order; the first match wins. | +**enabled** | **bool** | Whether the conditions are applied when rendering. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiMetricOut.md b/gooddata-api-client/docs/JsonApiMetricOut.md index 15de82d14..9bbaa9976 100644 --- a/gooddata-api-client/docs/JsonApiMetricOut.md +++ b/gooddata-api-client/docs/JsonApiMetricOut.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **attributes** | [**JsonApiMetricOutAttributes**](JsonApiMetricOutAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "metric" -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.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/JsonApiMetricOutAttributes.md b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md index fb550c7df..5723aca67 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricOutAttributes.md @@ -4,11 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | +**content** | [**JsonApiComputedAttributeInAttributesContent**](JsonApiComputedAttributeInAttributesContent.md) | | **are_relations_valid** | **bool** | | [optional] **certification** | **str** | Certification status of the entity. | [optional] if omitted the server will use the default value of "CERTIFIED" **certification_message** | **str, none_type** | Optional message associated with the certification. | [optional] **certified_at** | **datetime, none_type** | Time when the certification was set. | [optional] +**conditional_formatting** | [**JsonApiMetricInAttributesConditionalFormatting**](JsonApiMetricInAttributesConditionalFormatting.md) | | [optional] **created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiMetricOutDocument.md b/gooddata-api-client/docs/JsonApiMetricOutDocument.md index 85d95f58b..a1cc6c273 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutDocument.md +++ b/gooddata-api-client/docs/JsonApiMetricOutDocument.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiMetricOut**](JsonApiMetricOut.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiComputedAttributeOutIncludes]**](JsonApiComputedAttributeOutIncludes.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/JsonApiMetricOutList.md b/gooddata-api-client/docs/JsonApiMetricOutList.md index 9a24bf3c6..b6a7220c8 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutList.md +++ b/gooddata-api-client/docs/JsonApiMetricOutList.md @@ -6,7 +6,7 @@ A JSON:API document with a list of resources Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiMetricOutWithLinks]**](JsonApiMetricOutWithLinks.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiComputedAttributeOutIncludes]**](JsonApiComputedAttributeOutIncludes.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] diff --git a/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md b/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md index 9e5f39acd..3f8f1f8cd 100644 --- a/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiMetricOutWithLinks.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **attributes** | [**JsonApiMetricOutAttributes**](JsonApiMetricOutAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "metric" -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.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] diff --git a/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md b/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md index 81bc171e8..341c97981 100644 --- a/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiMetricPatchAttributes.md @@ -5,7 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] -**content** | [**JsonApiMetricInAttributesContent**](JsonApiMetricInAttributesContent.md) | | [optional] +**conditional_formatting** | [**JsonApiMetricInAttributesConditionalFormatting**](JsonApiMetricInAttributesConditionalFormatting.md) | | [optional] +**content** | [**JsonApiComputedAttributeInAttributesContent**](JsonApiComputedAttributeInAttributesContent.md) | | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] **is_hidden_from_kda** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md index 9fa572af3..55080f432 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelIdentifierOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiNotificationChannelIdentifierOutWithLinks]**](JsonApiNotificationChannelIdentifierOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiNotificationChannelOutList.md b/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md index 5d5e12cc2..941359681 100644 --- a/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md +++ b/gooddata-api-client/docs/JsonApiNotificationChannelOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiNotificationChannelOutWithLinks]**](JsonApiNotificationChannelOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiOrgMemoryItemOutDocument.md b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutDocument.md index e19e09473..0b3a382b3 100644 --- a/gooddata-api-client/docs/JsonApiOrgMemoryItemOutDocument.md +++ b/gooddata-api-client/docs/JsonApiOrgMemoryItemOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiOrgMemoryItemOut**](JsonApiOrgMemoryItemOut.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/JsonApiOrganizationOutDocument.md b/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md index a37fd7f87..d4503ac11 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md +++ b/gooddata-api-client/docs/JsonApiOrganizationOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiOrganizationOut**](JsonApiOrganizationOut.md) | | **included** | [**[JsonApiOrganizationOutIncludes]**](JsonApiOrganizationOutIncludes.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/JsonApiOrganizationSettingOutList.md b/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md index 157bd61e2..e18b978d8 100644 --- a/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiOrganizationSettingOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiOrganizationSettingOutWithLinks]**](JsonApiOrganizationSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiParameterOutDocument.md b/gooddata-api-client/docs/JsonApiParameterOutDocument.md index 1395c38de..d4d7b5afd 100644 --- a/gooddata-api-client/docs/JsonApiParameterOutDocument.md +++ b/gooddata-api-client/docs/JsonApiParameterOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiParameterOut**](JsonApiParameterOut.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/JsonApiReportIn.md b/gooddata-api-client/docs/JsonApiReportIn.md new file mode 100644 index 000000000..f799eb763 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportIn.md @@ -0,0 +1,15 @@ +# JsonApiReportIn + +JSON:API representation of report entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportInAttributes**](JsonApiReportInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "report" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiReportInAttributes.md b/gooddata-api-client/docs/JsonApiReportInAttributes.md new file mode 100644 index 000000000..3dcd13b07 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportInAttributes.md @@ -0,0 +1,19 @@ +# JsonApiReportInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | +**period_end** | **date** | Last day of the reported period, inclusive. | +**period_start** | **date** | First day of the reported period, inclusive. | +**title** | **str** | | +**are_relations_valid** | **bool** | | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [optional] +**variable_values** | **bool, date, datetime, dict, float, int, list, str, none_type** | Values for the variables declared in the content, keyed by name. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AttributePositiveFilter.md b/gooddata-api-client/docs/JsonApiReportInDocument.md similarity index 83% rename from gooddata-api-client/docs/AttributePositiveFilter.md rename to gooddata-api-client/docs/JsonApiReportInDocument.md index f0f19fe7c..3b72766d8 100644 --- a/gooddata-api-client/docs/AttributePositiveFilter.md +++ b/gooddata-api-client/docs/JsonApiReportInDocument.md @@ -1,11 +1,10 @@ -# AttributePositiveFilter +# JsonApiReportInDocument ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**include** | **[str]** | | -**using** | **str** | | +**data** | [**JsonApiReportIn**](JsonApiReportIn.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/JsonApiReportOut.md b/gooddata-api-client/docs/JsonApiReportOut.md new file mode 100644 index 000000000..96431e126 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportOut.md @@ -0,0 +1,17 @@ +# JsonApiReportOut + +JSON:API representation of report entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportOutAttributes**](JsonApiReportOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "report" +**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/JsonApiReportOutAttributes.md b/gooddata-api-client/docs/JsonApiReportOutAttributes.md new file mode 100644 index 000000000..2b445d0f7 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportOutAttributes.md @@ -0,0 +1,21 @@ +# JsonApiReportOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | +**period_end** | **date** | Last day of the reported period, inclusive. | +**period_start** | **date** | First day of the reported period, inclusive. | +**title** | **str** | | +**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] +**variable_values** | **bool, date, datetime, dict, float, int, list, str, none_type** | Values for the variables declared in the content, keyed by name. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiItemPipeTableSummary.md b/gooddata-api-client/docs/JsonApiReportOutDocument.md similarity index 54% rename from gooddata-api-client/docs/JsonApiItemPipeTableSummary.md rename to gooddata-api-client/docs/JsonApiReportOutDocument.md index 3f09a28f3..5666ba329 100644 --- a/gooddata-api-client/docs/JsonApiItemPipeTableSummary.md +++ b/gooddata-api-client/docs/JsonApiReportOutDocument.md @@ -1,13 +1,13 @@ -# JsonApiItemPipeTableSummary +# JsonApiReportOutDocument -A single JSON:API resource item ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attributes** | [**PipeTableSummary**](PipeTableSummary.md) | | -**id** | **str** | Resource identifier | -**type** | **str** | Resource type | +**data** | [**JsonApiReportOut**](JsonApiReportOut.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/JsonApiReportOutList.md b/gooddata-api-client/docs/JsonApiReportOutList.md new file mode 100644 index 000000000..e6c243603 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportOutList.md @@ -0,0 +1,16 @@ +# JsonApiReportOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiReportOutWithLinks]**](JsonApiReportOutWithLinks.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/JsonApiReportOutWithLinks.md b/gooddata-api-client/docs/JsonApiReportOutWithLinks.md new file mode 100644 index 000000000..e0e6e51bd --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiReportOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportOutAttributes**](JsonApiReportOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "report" +**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/JsonApiReportPageLayoutIn.md b/gooddata-api-client/docs/JsonApiReportPageLayoutIn.md new file mode 100644 index 000000000..0776ac923 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutIn.md @@ -0,0 +1,15 @@ +# JsonApiReportPageLayoutIn + +JSON:API representation of reportPageLayout entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportPageLayoutInAttributes**](JsonApiReportPageLayoutInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportPageLayout" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiReportPageLayoutInAttributes.md b/gooddata-api-client/docs/JsonApiReportPageLayoutInAttributes.md new file mode 100644 index 000000000..74a1e40e2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutInAttributes.md @@ -0,0 +1,16 @@ +# JsonApiReportPageLayoutInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | +**title** | **str** | | +**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/JsonApiReportPageLayoutInDocument.md b/gooddata-api-client/docs/JsonApiReportPageLayoutInDocument.md new file mode 100644 index 000000000..e5ac84140 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutInDocument.md @@ -0,0 +1,12 @@ +# JsonApiReportPageLayoutInDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportPageLayoutIn**](JsonApiReportPageLayoutIn.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/JsonApiReportPageLayoutOut.md b/gooddata-api-client/docs/JsonApiReportPageLayoutOut.md new file mode 100644 index 000000000..cf22752f2 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutOut.md @@ -0,0 +1,17 @@ +# JsonApiReportPageLayoutOut + +JSON:API representation of reportPageLayout entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportPageLayoutOutAttributes**](JsonApiReportPageLayoutOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportPageLayout" +**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/JsonApiReportPageLayoutOutAttributes.md b/gooddata-api-client/docs/JsonApiReportPageLayoutOutAttributes.md new file mode 100644 index 000000000..871582824 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutOutAttributes.md @@ -0,0 +1,18 @@ +# JsonApiReportPageLayoutOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | +**title** | **str** | | +**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/JsonApiReportPageLayoutOutDocument.md b/gooddata-api-client/docs/JsonApiReportPageLayoutOutDocument.md new file mode 100644 index 000000000..ebf576e45 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutOutDocument.md @@ -0,0 +1,15 @@ +# JsonApiReportPageLayoutOutDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportPageLayoutOut**](JsonApiReportPageLayoutOut.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/JsonApiReportPageLayoutOutList.md b/gooddata-api-client/docs/JsonApiReportPageLayoutOutList.md new file mode 100644 index 000000000..df89c7322 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutOutList.md @@ -0,0 +1,16 @@ +# JsonApiReportPageLayoutOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiReportPageLayoutOutWithLinks]**](JsonApiReportPageLayoutOutWithLinks.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/JsonApiReportPageLayoutOutWithLinks.md b/gooddata-api-client/docs/JsonApiReportPageLayoutOutWithLinks.md new file mode 100644 index 000000000..f8a265904 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiReportPageLayoutOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportPageLayoutOutAttributes**](JsonApiReportPageLayoutOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportPageLayout" +**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/JsonApiReportPageLayoutPatch.md b/gooddata-api-client/docs/JsonApiReportPageLayoutPatch.md new file mode 100644 index 000000000..fe5aeab13 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutPatch.md @@ -0,0 +1,15 @@ +# JsonApiReportPageLayoutPatch + +JSON:API representation of patching reportPageLayout entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportPageLayoutPatchAttributes**](JsonApiReportPageLayoutPatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportPageLayout" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiReportPageLayoutPatchAttributes.md b/gooddata-api-client/docs/JsonApiReportPageLayoutPatchAttributes.md new file mode 100644 index 000000000..a527b917a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutPatchAttributes.md @@ -0,0 +1,16 @@ +# JsonApiReportPageLayoutPatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [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/JsonApiReportPageLayoutPatchDocument.md b/gooddata-api-client/docs/JsonApiReportPageLayoutPatchDocument.md new file mode 100644 index 000000000..1393043a5 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutPatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiReportPageLayoutPatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportPageLayoutPatch**](JsonApiReportPageLayoutPatch.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/JsonApiReportPageLayoutPostOptionalId.md b/gooddata-api-client/docs/JsonApiReportPageLayoutPostOptionalId.md new file mode 100644 index 000000000..257316b10 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutPostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiReportPageLayoutPostOptionalId + +JSON:API representation of reportPageLayout entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportPageLayoutInAttributes**](JsonApiReportPageLayoutInAttributes.md) | | +**type** | **str** | Object type | defaults to "reportPageLayout" +**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/JsonApiReportPageLayoutPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiReportPageLayoutPostOptionalIdDocument.md new file mode 100644 index 000000000..6c30ecb31 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPageLayoutPostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiReportPageLayoutPostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportPageLayoutPostOptionalId**](JsonApiReportPageLayoutPostOptionalId.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/JsonApiReportPatch.md b/gooddata-api-client/docs/JsonApiReportPatch.md new file mode 100644 index 000000000..5ac6c14dd --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPatch.md @@ -0,0 +1,15 @@ +# JsonApiReportPatch + +JSON:API representation of patching report entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportPatchAttributes**](JsonApiReportPatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "report" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiReportPatchAttributes.md b/gooddata-api-client/docs/JsonApiReportPatchAttributes.md new file mode 100644 index 000000000..c9a07dd8d --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPatchAttributes.md @@ -0,0 +1,19 @@ +# JsonApiReportPatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | [optional] +**description** | **str** | | [optional] +**period_end** | **date** | Last day of the reported period, inclusive. | [optional] +**period_start** | **date** | First day of the reported period, inclusive. | [optional] +**tags** | **[str]** | | [optional] +**title** | **str** | | [optional] +**variable_values** | **bool, date, datetime, dict, float, int, list, str, none_type** | Values for the variables declared in the content, keyed by name. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/AttributeNegativeFilter.md b/gooddata-api-client/docs/JsonApiReportPatchDocument.md similarity index 82% rename from gooddata-api-client/docs/AttributeNegativeFilter.md rename to gooddata-api-client/docs/JsonApiReportPatchDocument.md index c58e94687..b9ec08282 100644 --- a/gooddata-api-client/docs/AttributeNegativeFilter.md +++ b/gooddata-api-client/docs/JsonApiReportPatchDocument.md @@ -1,11 +1,10 @@ -# AttributeNegativeFilter +# JsonApiReportPatchDocument ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exclude** | **[str]** | | -**using** | **str** | | +**data** | [**JsonApiReportPatch**](JsonApiReportPatch.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/JsonApiReportPostOptionalId.md b/gooddata-api-client/docs/JsonApiReportPostOptionalId.md new file mode 100644 index 000000000..5913636b3 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiReportPostOptionalId + +JSON:API representation of report entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportInAttributes**](JsonApiReportInAttributes.md) | | +**type** | **str** | Object type | defaults to "report" +**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/JsonApiReportPostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiReportPostOptionalIdDocument.md new file mode 100644 index 000000000..d3afb9360 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportPostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiReportPostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportPostOptionalId**](JsonApiReportPostOptionalId.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/JsonApiReportTemplateIn.md b/gooddata-api-client/docs/JsonApiReportTemplateIn.md new file mode 100644 index 000000000..f84d16ff4 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplateIn.md @@ -0,0 +1,15 @@ +# JsonApiReportTemplateIn + +JSON:API representation of reportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportTemplateInAttributes**](JsonApiReportTemplateInAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportTemplate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/WidgetDescriptor.md b/gooddata-api-client/docs/JsonApiReportTemplateInAttributes.md similarity index 54% rename from gooddata-api-client/docs/WidgetDescriptor.md rename to gooddata-api-client/docs/JsonApiReportTemplateInAttributes.md index 1f9dc9950..418d0a950 100644 --- a/gooddata-api-client/docs/WidgetDescriptor.md +++ b/gooddata-api-client/docs/JsonApiReportTemplateInAttributes.md @@ -1,14 +1,14 @@ -# WidgetDescriptor +# JsonApiReportTemplateInAttributes -Descriptor for a widget on the dashboard. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | **title** | **str** | | -**widget_id** | **str** | | -**widget_type** | **str** | | -**filters** | [**[FilterDefinition]**](FilterDefinition.md) | | [optional] +**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/AttributeNegativeFilterAllOf.md b/gooddata-api-client/docs/JsonApiReportTemplateInDocument.md similarity index 80% rename from gooddata-api-client/docs/AttributeNegativeFilterAllOf.md rename to gooddata-api-client/docs/JsonApiReportTemplateInDocument.md index dd0d8887d..4e08b7835 100644 --- a/gooddata-api-client/docs/AttributeNegativeFilterAllOf.md +++ b/gooddata-api-client/docs/JsonApiReportTemplateInDocument.md @@ -1,11 +1,10 @@ -# AttributeNegativeFilterAllOf +# JsonApiReportTemplateInDocument ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**exclude** | **[str]** | | [optional] -**using** | **str** | | [optional] +**data** | [**JsonApiReportTemplateIn**](JsonApiReportTemplateIn.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/JsonApiReportTemplateOut.md b/gooddata-api-client/docs/JsonApiReportTemplateOut.md new file mode 100644 index 000000000..3d6b3c526 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplateOut.md @@ -0,0 +1,17 @@ +# JsonApiReportTemplateOut + +JSON:API representation of reportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportTemplateOutAttributes**](JsonApiReportTemplateOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportTemplate" +**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/JsonApiReportTemplateOutAttributes.md b/gooddata-api-client/docs/JsonApiReportTemplateOutAttributes.md new file mode 100644 index 000000000..f17d0da17 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplateOutAttributes.md @@ -0,0 +1,18 @@ +# JsonApiReportTemplateOutAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | +**title** | **str** | | +**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/SavedVisualization.md b/gooddata-api-client/docs/JsonApiReportTemplateOutDocument.md similarity index 52% rename from gooddata-api-client/docs/SavedVisualization.md rename to gooddata-api-client/docs/JsonApiReportTemplateOutDocument.md index a8e13553a..f0c331e5a 100644 --- a/gooddata-api-client/docs/SavedVisualization.md +++ b/gooddata-api-client/docs/JsonApiReportTemplateOutDocument.md @@ -1,12 +1,13 @@ -# SavedVisualization +# JsonApiReportTemplateOutDocument -Created and saved visualization IDs. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**created_visualization_id** | **str** | Created visualization ID. | -**saved_visualization_id** | **str** | Saved visualization ID. | +**data** | [**JsonApiReportTemplateOut**](JsonApiReportTemplateOut.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/JsonApiReportTemplateOutList.md b/gooddata-api-client/docs/JsonApiReportTemplateOutList.md new file mode 100644 index 000000000..15ec44d1b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplateOutList.md @@ -0,0 +1,16 @@ +# JsonApiReportTemplateOutList + +A JSON:API document with a list of resources + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**[JsonApiReportTemplateOutWithLinks]**](JsonApiReportTemplateOutWithLinks.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/JsonApiReportTemplateOutWithLinks.md b/gooddata-api-client/docs/JsonApiReportTemplateOutWithLinks.md new file mode 100644 index 000000000..8c9ed3055 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplateOutWithLinks.md @@ -0,0 +1,17 @@ +# JsonApiReportTemplateOutWithLinks + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportTemplateOutAttributes**](JsonApiReportTemplateOutAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportTemplate" +**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/JsonApiReportTemplatePatch.md b/gooddata-api-client/docs/JsonApiReportTemplatePatch.md new file mode 100644 index 000000000..37095bd85 --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplatePatch.md @@ -0,0 +1,15 @@ +# JsonApiReportTemplatePatch + +JSON:API representation of patching reportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportTemplatePatchAttributes**](JsonApiReportTemplatePatchAttributes.md) | | +**id** | **str** | API identifier of an object | +**type** | **str** | Object type | defaults to "reportTemplate" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiReportTemplatePatchAttributes.md b/gooddata-api-client/docs/JsonApiReportTemplatePatchAttributes.md new file mode 100644 index 000000000..35525681a --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplatePatchAttributes.md @@ -0,0 +1,16 @@ +# JsonApiReportTemplatePatchAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**are_relations_valid** | **bool** | | [optional] +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. | [optional] +**description** | **str** | | [optional] +**tags** | **[str]** | | [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/JsonApiReportTemplatePatchDocument.md b/gooddata-api-client/docs/JsonApiReportTemplatePatchDocument.md new file mode 100644 index 000000000..c996b3e2e --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplatePatchDocument.md @@ -0,0 +1,12 @@ +# JsonApiReportTemplatePatchDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportTemplatePatch**](JsonApiReportTemplatePatch.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/JsonApiReportTemplatePostOptionalId.md b/gooddata-api-client/docs/JsonApiReportTemplatePostOptionalId.md new file mode 100644 index 000000000..725a6a15c --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplatePostOptionalId.md @@ -0,0 +1,15 @@ +# JsonApiReportTemplatePostOptionalId + +JSON:API representation of reportTemplate entity. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**JsonApiReportTemplateInAttributes**](JsonApiReportTemplateInAttributes.md) | | +**type** | **str** | Object type | defaults to "reportTemplate" +**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/JsonApiReportTemplatePostOptionalIdDocument.md b/gooddata-api-client/docs/JsonApiReportTemplatePostOptionalIdDocument.md new file mode 100644 index 000000000..f3c2a92fd --- /dev/null +++ b/gooddata-api-client/docs/JsonApiReportTemplatePostOptionalIdDocument.md @@ -0,0 +1,12 @@ +# JsonApiReportTemplatePostOptionalIdDocument + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**JsonApiReportTemplatePostOptionalId**](JsonApiReportTemplatePostOptionalId.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/JsonApiThemeOutList.md b/gooddata-api-client/docs/JsonApiThemeOutList.md index 992ff6e9b..e4433f185 100644 --- a/gooddata-api-client/docs/JsonApiThemeOutList.md +++ b/gooddata-api-client/docs/JsonApiThemeOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiThemeOutWithLinks]**](JsonApiThemeOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiUserDataFilterOutDocument.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md index 2d18a32a6..53f9b9bcc 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiUserDataFilterOut**](JsonApiUserDataFilterOut.md) | | **included** | [**[JsonApiUserDataFilterOutIncludes]**](JsonApiUserDataFilterOutIncludes.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/JsonApiUserDataFilterOutRelationships.md b/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md index d9a9ade01..bd8094978 100644 --- a/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md +++ b/gooddata-api-client/docs/JsonApiUserDataFilterOutRelationships.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributes** | [**JsonApiAttributeHierarchyOutRelationshipsAttributes**](JsonApiAttributeHierarchyOutRelationshipsAttributes.md) | | [optional] +**computed_attributes** | [**JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes**](JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes.md) | | [optional] **datasets** | [**JsonApiAnalyticalDashboardOutRelationshipsDatasets**](JsonApiAnalyticalDashboardOutRelationshipsDatasets.md) | | [optional] -**facts** | [**JsonApiDatasetOutRelationshipsFacts**](JsonApiDatasetOutRelationshipsFacts.md) | | [optional] +**facts** | [**JsonApiAutomationOutRelationshipsFacts**](JsonApiAutomationOutRelationshipsFacts.md) | | [optional] **labels** | [**JsonApiAnalyticalDashboardOutRelationshipsLabels**](JsonApiAnalyticalDashboardOutRelationshipsLabels.md) | | [optional] **metrics** | [**JsonApiAnalyticalDashboardOutRelationshipsMetrics**](JsonApiAnalyticalDashboardOutRelationshipsMetrics.md) | | [optional] **parameters** | [**JsonApiAnalyticalDashboardOutRelationshipsParameters**](JsonApiAnalyticalDashboardOutRelationshipsParameters.md) | | [optional] diff --git a/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md b/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md index 518e9512d..b50ec43af 100644 --- a/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserGroupOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiUserGroupOut**](JsonApiUserGroupOut.md) | | **included** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.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/JsonApiUserIdentifierOutList.md b/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md index 1cc2c5f94..fea7905fc 100644 --- a/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md +++ b/gooddata-api-client/docs/JsonApiUserIdentifierOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiUserIdentifierOutWithLinks]**](JsonApiUserIdentifierOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiUserOutDocument.md b/gooddata-api-client/docs/JsonApiUserOutDocument.md index 06fb1020a..2d3d6f5b8 100644 --- a/gooddata-api-client/docs/JsonApiUserOutDocument.md +++ b/gooddata-api-client/docs/JsonApiUserOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiUserOut**](JsonApiUserOut.md) | | **included** | [**[JsonApiUserGroupOutWithLinks]**](JsonApiUserGroupOutWithLinks.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/JsonApiUserSettingIn.md b/gooddata-api-client/docs/JsonApiUserSettingIn.md index 1fe5520e6..c298ae477 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingIn.md +++ b/gooddata-api-client/docs/JsonApiUserSettingIn.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "userSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.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/JsonApiUserSettingInAttributes.md b/gooddata-api-client/docs/JsonApiUserSettingInAttributes.md new file mode 100644 index 000000000..b469aff3b --- /dev/null +++ b/gooddata-api-client/docs/JsonApiUserSettingInAttributes.md @@ -0,0 +1,13 @@ +# JsonApiUserSettingInAttributes + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 15000 characters. | [optional] +**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/JsonApiUserSettingOut.md b/gooddata-api-client/docs/JsonApiUserSettingOut.md index cfe7b3dd9..043c2d45e 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOut.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOut.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "userSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.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/JsonApiUserSettingOutList.md b/gooddata-api-client/docs/JsonApiUserSettingOutList.md index 6474cf248..06d198b7a 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiUserSettingOutWithLinks]**](JsonApiUserSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiUserSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md index 3c893dd2a..1a4f38cd9 100644 --- a/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiUserSettingOutWithLinks.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "userSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.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] diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md index 9fdaec069..0a0e8ce49 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributes.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | **are_relations_valid** | **bool** | | [optional] +**conditional_formatting** | [**JsonApiVisualizationObjectInAttributesConditionalFormatting**](JsonApiVisualizationObjectInAttributesConditionalFormatting.md) | | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] **tags** | **[str]** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributesConditionalFormatting.md b/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributesConditionalFormatting.md new file mode 100644 index 000000000..709636ffc --- /dev/null +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectInAttributesConditionalFormatting.md @@ -0,0 +1,14 @@ +# JsonApiVisualizationObjectInAttributesConditionalFormatting + +Conditional formatting applied when this visualization is rendered. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | Whether the rules are applied when rendering. | +**rules** | [**[ConditionalFormattingRule]**](ConditionalFormattingRule.md) | Rules evaluated in order; within a target, the first matching condition wins. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md index 0b593f8eb..db9b2b5ab 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOut.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "visualizationObject" -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.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/JsonApiVisualizationObjectOutAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md index 75b77ebf6..01ef6d006 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutAttributes.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **certification** | **str** | Certification status of the entity. | [optional] if omitted the server will use the default value of "CERTIFIED" **certification_message** | **str, none_type** | Optional message associated with the certification. | [optional] **certified_at** | **datetime, none_type** | Time when the certification was set. | [optional] +**conditional_formatting** | [**JsonApiVisualizationObjectInAttributesConditionalFormatting**](JsonApiVisualizationObjectInAttributesConditionalFormatting.md) | | [optional] **created_at** | **datetime, none_type** | Time of the entity creation. | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md index 72ed05614..4989f61a4 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutDocument.md @@ -5,8 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**JsonApiVisualizationObjectOut**](JsonApiVisualizationObjectOut.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiComputedAttributeOutIncludes]**](JsonApiComputedAttributeOutIncludes.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/JsonApiVisualizationObjectOutList.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md index bb5a54f73..519ddca40 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutList.md @@ -6,7 +6,7 @@ A JSON:API document with a list of resources Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiVisualizationObjectOutWithLinks]**](JsonApiVisualizationObjectOutWithLinks.md) | | -**included** | [**[JsonApiMetricOutIncludes]**](JsonApiMetricOutIncludes.md) | Included resources | [optional] +**included** | [**[JsonApiComputedAttributeOutIncludes]**](JsonApiComputedAttributeOutIncludes.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] diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md b/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md index bfc02c912..923f03cfe 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectOutWithLinks.md @@ -7,8 +7,8 @@ Name | Type | Description | Notes **attributes** | [**JsonApiVisualizationObjectOutAttributes**](JsonApiVisualizationObjectOutAttributes.md) | | **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "visualizationObject" -**meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] -**relationships** | [**JsonApiMetricOutRelationships**](JsonApiMetricOutRelationships.md) | | [optional] +**meta** | [**JsonApiAttributeOutMeta**](JsonApiAttributeOutMeta.md) | | [optional] +**relationships** | [**JsonApiComputedAttributeOutRelationships**](JsonApiComputedAttributeOutRelationships.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] diff --git a/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md b/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md index b202c526d..d3dbc56b3 100644 --- a/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md +++ b/gooddata-api-client/docs/JsonApiVisualizationObjectPatchAttributes.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **are_relations_valid** | **bool** | | [optional] +**conditional_formatting** | [**JsonApiVisualizationObjectInAttributesConditionalFormatting**](JsonApiVisualizationObjectInAttributesConditionalFormatting.md) | | [optional] **content** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Free-form JSON content. Maximum supported length is 250000 characters. | [optional] **description** | **str** | | [optional] **is_hidden** | **bool** | | [optional] diff --git a/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutList.md index 3cc815907..d9e0fa9c9 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceColorPaletteOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiWorkspaceColorPaletteOutWithLinks]**](JsonApiWorkspaceColorPaletteOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiWorkspaceDataFilterOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md index a5fe9fb3d..e17f8d177 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiWorkspaceDataFilterOut**](JsonApiWorkspaceDataFilterOut.md) | | **included** | [**[JsonApiWorkspaceDataFilterSettingOutWithLinks]**](JsonApiWorkspaceDataFilterSettingOutWithLinks.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/JsonApiWorkspaceDataFilterSettingOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md index 20ee4e082..2c1ef765b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceDataFilterSettingOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiWorkspaceDataFilterSettingOut**](JsonApiWorkspaceDataFilterSettingOut.md) | | **included** | [**[JsonApiWorkspaceDataFilterOutWithLinks]**](JsonApiWorkspaceDataFilterOutWithLinks.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/JsonApiWorkspaceExportTemplateOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutList.md index d7a250b37..902b7b0d4 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceExportTemplateOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiWorkspaceExportTemplateOutWithLinks]**](JsonApiWorkspaceExportTemplateOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiWorkspaceOutDocument.md b/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md index 6991c9531..fcde0e1ac 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceOutDocument.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **data** | [**JsonApiWorkspaceOut**](JsonApiWorkspaceOut.md) | | **included** | [**[JsonApiWorkspaceOutWithLinks]**](JsonApiWorkspaceOutWithLinks.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/JsonApiWorkspaceSettingIn.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md index 225c4be82..d56688af2 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingIn.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspaceSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.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/JsonApiWorkspaceSettingOut.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md index a7049defe..83a5f8a63 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOut.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspaceSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md index a13522e3a..4f0c49970 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiWorkspaceSettingOutWithLinks]**](JsonApiWorkspaceSettingOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/JsonApiWorkspaceSettingOutWithLinks.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md index e76e2d81b..616e948fc 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingOutWithLinks.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspaceSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.md) | | [optional] **meta** | [**JsonApiAggregatedFactOutMeta**](JsonApiAggregatedFactOutMeta.md) | | [optional] **links** | [**ObjectLinks**](ObjectLinks.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md index 59f213615..68723737e 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingPatch.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | API identifier of an object | **type** | **str** | Object type | defaults to "workspaceSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.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/JsonApiWorkspaceSettingPostOptionalId.md b/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md index c2f4edf37..6251fb8c4 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceSettingPostOptionalId.md @@ -6,7 +6,7 @@ JSON:API representation of workspaceSetting entity. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | Object type | defaults to "workspaceSetting" -**attributes** | [**JsonApiOrganizationSettingInAttributes**](JsonApiOrganizationSettingInAttributes.md) | | [optional] +**attributes** | [**JsonApiUserSettingInAttributes**](JsonApiUserSettingInAttributes.md) | | [optional] **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] diff --git a/gooddata-api-client/docs/JsonApiWorkspaceThemeOutList.md b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutList.md index 542e74fc2..f3fde993b 100644 --- a/gooddata-api-client/docs/JsonApiWorkspaceThemeOutList.md +++ b/gooddata-api-client/docs/JsonApiWorkspaceThemeOutList.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **data** | [**[JsonApiWorkspaceThemeOutWithLinks]**](JsonApiWorkspaceThemeOutWithLinks.md) | | **links** | [**ListLinks**](ListLinks.md) | | [optional] -**meta** | [**JsonApiAgentOutListMeta**](JsonApiAgentOutListMeta.md) | | [optional] +**meta** | [**JsonApiApiTokenOutListMeta**](JsonApiApiTokenOutListMeta.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/KeyConfig.md b/gooddata-api-client/docs/KeyConfig.md deleted file mode 100644 index a87fa6d95..000000000 --- a/gooddata-api-client/docs/KeyConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# KeyConfig - -Key configuration for the table data model. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/KnowledgeRecommendationsApi.md b/gooddata-api-client/docs/KnowledgeRecommendationsApi.md new file mode 100644 index 000000000..1b7419914 --- /dev/null +++ b/gooddata-api-client/docs/KnowledgeRecommendationsApi.md @@ -0,0 +1,720 @@ +# gooddata_api_client.KnowledgeRecommendationsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Post Knowledge Recommendations +[**delete_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Delete a Knowledge Recommendation +[**get_all_entities_knowledge_recommendations**](KnowledgeRecommendationsApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations +[**get_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation +[**patch_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation +[**search_entities_knowledge_recommendations**](KnowledgeRecommendationsApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) +[**update_entity_knowledge_recommendations**](KnowledgeRecommendationsApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation + + +# **create_entity_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) + +Post Knowledge Recommendations + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_api +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument +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 = knowledge_recommendations_api.KnowledgeRecommendationsApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_knowledge_recommendation_post_optional_id_document = JsonApiKnowledgeRecommendationPostOptionalIdDocument( + data=JsonApiKnowledgeRecommendationPostOptionalId( + attributes=JsonApiKnowledgeRecommendationInAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, + are_relations_valid=True, + comparison_type="MONTH", + confidence=None, + description="description_example", + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, + tags=[ + "tags_example", + ], + title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", + ), + id="id1", + relationships=JsonApiKnowledgeRecommendationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) # JsonApiKnowledgeRecommendationPostOptionalIdDocument | + include = [ + "metric,analyticalDashboard", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Post Knowledge Recommendations + api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->create_entity_knowledge_recommendations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Knowledge Recommendations + api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->create_entity_knowledge_recommendations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_knowledge_recommendation_post_optional_id_document** | [**JsonApiKnowledgeRecommendationPostOptionalIdDocument**](JsonApiKnowledgeRecommendationPostOptionalIdDocument.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 + +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.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_knowledge_recommendations** +> delete_entity_knowledge_recommendations(workspace_id, object_id) + +Delete a Knowledge Recommendation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_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 = knowledge_recommendations_api.KnowledgeRecommendationsApi(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 Knowledge Recommendation + api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->delete_entity_knowledge_recommendations: %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_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutList get_all_entities_knowledge_recommendations(workspace_id) + +Get all Knowledge Recommendations + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_api +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +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 = knowledge_recommendations_api.KnowledgeRecommendationsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "metric,analyticalDashboard", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + 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 Knowledge Recommendations + api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->get_all_entities_knowledge_recommendations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Knowledge Recommendations + api_response = api_instance.get_all_entities_knowledge_recommendations(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 KnowledgeRecommendationsApi->get_all_entities_knowledge_recommendations: %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 + +[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.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_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) + +Get a Knowledge Recommendation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_api +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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 = knowledge_recommendations_api.KnowledgeRecommendationsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "metric,analyticalDashboard", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Knowledge Recommendation + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->get_entity_knowledge_recommendations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Knowledge Recommendation + api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->get_entity_knowledge_recommendations: %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 + +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.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_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) + +Patch a Knowledge Recommendation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_api +from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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 = knowledge_recommendations_api.KnowledgeRecommendationsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_knowledge_recommendation_patch_document = JsonApiKnowledgeRecommendationPatchDocument( + data=JsonApiKnowledgeRecommendationPatch( + attributes=JsonApiKnowledgeRecommendationPatchAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, + are_relations_valid=True, + comparison_type="MONTH", + confidence=None, + description="description_example", + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, + tags=[ + "tags_example", + ], + title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", + ), + id="id1", + relationships=JsonApiKnowledgeRecommendationOutRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) # JsonApiKnowledgeRecommendationPatchDocument | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "metric,analyticalDashboard", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch a Knowledge Recommendation + api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->patch_entity_knowledge_recommendations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Knowledge Recommendation + api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->patch_entity_knowledge_recommendations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_knowledge_recommendation_patch_document** | [**JsonApiKnowledgeRecommendationPatchDocument**](JsonApiKnowledgeRecommendationPatchDocument.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 + +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.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) + +# **search_entities_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_api +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = knowledge_recommendations_api.KnowledgeRecommendationsApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->search_entities_knowledge_recommendations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->search_entities_knowledge_recommendations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**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_knowledge_recommendations** +> JsonApiKnowledgeRecommendationOutDocument update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) + +Put a Knowledge Recommendation + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import knowledge_recommendations_api +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument +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 = knowledge_recommendations_api.KnowledgeRecommendationsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_knowledge_recommendation_in_document = JsonApiKnowledgeRecommendationInDocument( + data=JsonApiKnowledgeRecommendationIn( + attributes=JsonApiKnowledgeRecommendationInAttributes( + analytical_dashboard_title="Portfolio Health Insights", + analyzed_period="2023-07", + analyzed_value=None, + are_relations_valid=True, + comparison_type="MONTH", + confidence=None, + description="description_example", + direction="DECREASED", + metric_title="Revenue", + recommendations={}, + reference_period="2023-06", + reference_value=None, + source_count=2, + tags=[ + "tags_example", + ], + title="title_example", + widget_id="widget-123", + widget_name="Revenue Trend", + ), + id="id1", + relationships=JsonApiKnowledgeRecommendationInRelationships( + analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( + data=JsonApiAnalyticalDashboardToOneLinkage(None), + ), + metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( + data=JsonApiMetricToOneLinkage(None), + ), + ), + type="knowledgeRecommendation", + ), + ) # JsonApiKnowledgeRecommendationInDocument | + filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "metric,analyticalDashboard", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put a Knowledge Recommendation + api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->update_entity_knowledge_recommendations: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Knowledge Recommendation + api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling KnowledgeRecommendationsApi->update_entity_knowledge_recommendations: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_knowledge_recommendation_in_document** | [**JsonApiKnowledgeRecommendationInDocument**](JsonApiKnowledgeRecommendationInDocument.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 + +[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.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/LDMDeclarativeAPIsApi.md b/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md index 14e759afb..3a62ac78c 100644 --- a/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/LDMDeclarativeAPIsApi.md @@ -166,6 +166,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -176,6 +191,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -291,6 +321,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", diff --git a/gooddata-api-client/docs/LabelControllerApi.md b/gooddata-api-client/docs/LabelControllerApi.md index ef820851e..584b87bcb 100644 --- a/gooddata-api-client/docs/LabelControllerApi.md +++ b/gooddata-api-client/docs/LabelControllerApi.md @@ -48,7 +48,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -139,7 +139,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -224,7 +224,22 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_label_patch_document = JsonApiLabelPatchDocument( data=JsonApiLabelPatch( - attributes=JsonApiAttributePatchAttributes( + attributes=JsonApiLabelPatchAttributes( + conditional_formatting=JsonApiLabelOutAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/LabelsApi.md b/gooddata-api-client/docs/LabelsApi.md index 99c819b1f..287f7bac2 100644 --- a/gooddata-api-client/docs/LabelsApi.md +++ b/gooddata-api-client/docs/LabelsApi.md @@ -48,7 +48,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -139,7 +139,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -224,7 +224,22 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_label_patch_document = JsonApiLabelPatchDocument( data=JsonApiLabelPatch( - attributes=JsonApiAttributePatchAttributes( + attributes=JsonApiLabelPatchAttributes( + conditional_formatting=JsonApiLabelOutAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="description_example", tags=[ "tags_example", diff --git a/gooddata-api-client/docs/LayoutApi.md b/gooddata-api-client/docs/LayoutApi.md index 00d5029a6..f671730a8 100644 --- a/gooddata-api-client/docs/LayoutApi.md +++ b/gooddata-api-client/docs/LayoutApi.md @@ -1896,6 +1896,7 @@ with gooddata_api_client.ApiClient() as api_client: value="value_example", ), ], + disable_statistics=True, id="pg_local_docker-demo", name="postgres demo", parameters=[ @@ -2356,6 +2357,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -2436,6 +2473,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -2474,6 +2526,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -2483,6 +2573,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -2553,6 +2664,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -2563,6 +2689,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -2678,6 +2819,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", @@ -2775,6 +2931,14 @@ with gooddata_api_client.ApiClient() as api_client: description="description_example", enabled=True, id="default-ai-assistant", + instructions=[ + Instruction( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -2917,6 +3081,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -2997,6 +3197,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -3035,6 +3250,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -3044,6 +3297,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -3168,6 +3442,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -3366,6 +3645,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -4042,6 +4342,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -4052,6 +4367,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -4167,6 +4497,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", @@ -4344,6 +4689,14 @@ with gooddata_api_client.ApiClient() as api_client: description="description_example", enabled=True, id="default-ai-assistant", + instructions=[ + Instruction( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -4382,6 +4735,7 @@ with gooddata_api_client.ApiClient() as api_client: value="value_example", ), ], + disable_statistics=True, id="pg_local_docker-demo", name="postgres demo", parameters=[ @@ -4711,6 +5065,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -4909,6 +5268,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -5188,6 +5568,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -5268,6 +5684,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -5306,6 +5737,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -5315,6 +5784,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -5385,6 +5875,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -5395,6 +5900,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -5510,6 +6030,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", @@ -6197,6 +6732,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -6395,6 +6935,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -6674,6 +7235,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -6754,6 +7351,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -6792,6 +7404,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -6801,6 +7451,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -6871,6 +7542,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -6881,6 +7567,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -6996,6 +7697,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", diff --git a/gooddata-api-client/docs/ManageComputedAttributePermissionsRequestInner.md b/gooddata-api-client/docs/ManageComputedAttributePermissionsRequestInner.md new file mode 100644 index 000000000..2b19677d8 --- /dev/null +++ b/gooddata-api-client/docs/ManageComputedAttributePermissionsRequestInner.md @@ -0,0 +1,14 @@ +# ManageComputedAttributePermissionsRequestInner + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | [optional] +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] +**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ObjectReferenceGroup.md b/gooddata-api-client/docs/ManageVisualizationPermissionsRequestInner.md similarity index 64% rename from gooddata-api-client/docs/ObjectReferenceGroup.md rename to gooddata-api-client/docs/ManageVisualizationPermissionsRequestInner.md index fdabb612f..b7739eafb 100644 --- a/gooddata-api-client/docs/ObjectReferenceGroup.md +++ b/gooddata-api-client/docs/ManageVisualizationPermissionsRequestInner.md @@ -1,11 +1,12 @@ -# ObjectReferenceGroup +# ManageVisualizationPermissionsRequestInner ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**objects** | [**[ObjectReference]**](ObjectReference.md) | Objects the user explicitly referenced within this context. | -**context** | [**ObjectReference**](ObjectReference.md) | | [optional] +**permissions** | **[str]** | | [optional] +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | [optional] +**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/MemoryItemsApi.md b/gooddata-api-client/docs/MemoryItemsApi.md new file mode 100644 index 000000000..838a28931 --- /dev/null +++ b/gooddata-api-client/docs/MemoryItemsApi.md @@ -0,0 +1,1198 @@ +# gooddata_api_client.MemoryItemsApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_memory_items**](MemoryItemsApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items +[**create_entity_org_memory_items**](MemoryItemsApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities +[**delete_entity_memory_items**](MemoryItemsApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item +[**delete_entity_org_memory_items**](MemoryItemsApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity +[**get_all_entities_memory_items**](MemoryItemsApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items +[**get_all_entities_org_memory_items**](MemoryItemsApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities +[**get_entity_memory_items**](MemoryItemsApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item +[**get_entity_org_memory_items**](MemoryItemsApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity +[**patch_entity_memory_items**](MemoryItemsApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item +[**patch_entity_org_memory_items**](MemoryItemsApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity +[**search_entities_memory_items**](MemoryItemsApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) +[**update_entity_memory_items**](MemoryItemsApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item +[**update_entity_org_memory_items**](MemoryItemsApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity + + +# **create_entity_memory_items** +> JsonApiMemoryItemOutDocument create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) + +Post Memory Items + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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 = memory_items_api.MemoryItemsApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_memory_item_post_optional_id_document = JsonApiMemoryItemPostOptionalIdDocument( + data=JsonApiMemoryItemPostOptionalId( + attributes=JsonApiMemoryItemInAttributes( + are_relations_valid=True, + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="memoryItem", + ), + ) # JsonApiMemoryItemPostOptionalIdDocument | + 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 Memory Items + api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->create_entity_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Memory Items + api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->create_entity_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_memory_item_post_optional_id_document** | [**JsonApiMemoryItemPostOptionalIdDocument**](JsonApiMemoryItemPostOptionalIdDocument.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 + +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.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_org_memory_items** +> JsonApiOrgMemoryItemOutDocument create_entity_org_memory_items(json_api_org_memory_item_in_document) + +Post organization Memory Item entities + +Organization-scoped AI memory item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = memory_items_api.MemoryItemsApi(api_client) + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->create_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post organization Memory Item entities + api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->create_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**201** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete_entity_memory_items** +> delete_entity_memory_items(workspace_id, object_id) + +Delete a Memory Item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_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 = memory_items_api.MemoryItemsApi(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 Memory Item + api_instance.delete_entity_memory_items(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->delete_entity_memory_items: %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_org_memory_items** +> delete_entity_org_memory_items(id) + +Delete an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_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 = memory_items_api.MemoryItemsApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + + # example passing only required values which don't have defaults set + try: + # Delete an organization Memory Item entity + api_instance.delete_entity_org_memory_items(id) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->delete_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | Successfully deleted | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_all_entities_memory_items** +> JsonApiMemoryItemOutList get_all_entities_memory_items(workspace_id) + +Get all Memory Items + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +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 = memory_items_api.MemoryItemsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;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 Memory Items + api_response = api_instance.get_all_entities_memory_items(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->get_all_entities_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Memory Items + api_response = api_instance.get_all_entities_memory_items(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 MemoryItemsApi->get_all_entities_memory_items: %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 + +[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.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_org_memory_items** +> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() + +Get all organization Memory Item entities + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = memory_items_api.MemoryItemsApi(api_client) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0 + size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20 + sort = [ + "sort_example", + ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) + meta_include = [ + "metaInclude=page,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all organization Memory Item entities + api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->get_all_entities_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + **page** | **int**| Zero-based page index (0..N) | [optional] if omitted the server will use the default value of 0 + **size** | **int**| The size of the page to be returned | [optional] if omitted the server will use the default value of 20 + **sort** | **[str]**| Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | [optional] + **meta_include** | **[str]**| Include Meta objects. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_memory_items** +> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) + +Get a Memory Item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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 = memory_items_api.MemoryItemsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Memory Item + api_response = api_instance.get_entity_memory_items(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->get_entity_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Memory Item + api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->get_entity_memory_items: %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 + +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) + +Get an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = memory_items_api.MemoryItemsApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->get_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get an organization Memory Item entity + api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->get_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **patch_entity_memory_items** +> JsonApiMemoryItemOutDocument patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) + +Patch a Memory Item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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 = memory_items_api.MemoryItemsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_memory_item_patch_document = JsonApiMemoryItemPatchDocument( + data=JsonApiMemoryItemPatch( + attributes=JsonApiMemoryItemPatchAttributes( + are_relations_valid=True, + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="memoryItem", + ), + ) # JsonApiMemoryItemPatchDocument | + 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 Memory Item + api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->patch_entity_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Memory Item + api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->patch_entity_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_memory_item_patch_document** | [**JsonApiMemoryItemPatchDocument**](JsonApiMemoryItemPatchDocument.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 + +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.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_org_memory_items** +> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + +Patch an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = memory_items_api.MemoryItemsApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( + data=JsonApiOrgMemoryItemPatch( + attributes=JsonApiOrgMemoryItemPatchAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->patch_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch an organization Memory Item entity + api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->patch_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **search_entities_memory_items** +> JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) + +The search endpoint (beta) + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.model.entity_search_body import EntitySearchBody +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = memory_items_api.MemoryItemsApi(api_client) + workspace_id = "workspaceId_example" # str | + entity_search_body = EntitySearchBody( + filter="filter_example", + include=[ + "include_example", + ], + meta_include=[ + "meta_include_example", + ], + page=EntitySearchPage( + index=0, + size=100, + ), + sort=[ + EntitySearchSort( + direction="ASC", + _property="_property_example", + ), + ], + ) # EntitySearchBody | Search request body with filter, pagination, and sorting options + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + + # example passing only required values which don't have defaults set + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->search_entities_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # The search endpoint (beta) + api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->search_entities_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | + **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" + **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False + +### Return type + +[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**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_memory_items** +> JsonApiMemoryItemOutDocument update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) + +Put a Memory Item + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +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 = memory_items_api.MemoryItemsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_memory_item_in_document = JsonApiMemoryItemInDocument( + data=JsonApiMemoryItemIn( + attributes=JsonApiMemoryItemInAttributes( + are_relations_valid=True, + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="memoryItem", + ), + ) # JsonApiMemoryItemInDocument | + 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 Memory Item + api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->update_entity_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Memory Item + api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->update_entity_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_memory_item_in_document** | [**JsonApiMemoryItemInDocument**](JsonApiMemoryItemInDocument.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 + +[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_entity_org_memory_items** +> JsonApiOrgMemoryItemOutDocument update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + +Put an organization Memory Item entity + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import memory_items_api +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = memory_items_api.MemoryItemsApi(api_client) + id = "/6bUUGjjNSwg0_bs" # str | + json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( + data=JsonApiOrgMemoryItemIn( + attributes=JsonApiOrgMemoryItemInAttributes( + description="description_example", + instruction="instruction_example", + is_disabled=True, + keywords=[ + "keywords_example", + ], + strategy="ALWAYS", + title="title_example", + ), + id="id1", + type="orgMemoryItem", + ), + ) # JsonApiOrgMemoryItemInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + + # example passing only required values which don't have defaults set + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->update_entity_org_memory_items: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put an organization Memory Item entity + api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling MemoryItemsApi->update_entity_org_memory_items: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| | + **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] + **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] + +### Return type + +[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json, application/vnd.gooddata.api+json + - **Accept**: application/json, application/vnd.gooddata.api+json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Request successfully processed | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/MetadataSynchronizationApi.md b/gooddata-api-client/docs/MetadataSynchronizationApi.md new file mode 100644 index 000000000..c28e7ce40 --- /dev/null +++ b/gooddata-api-client/docs/MetadataSynchronizationApi.md @@ -0,0 +1,70 @@ +# gooddata_api_client.MetadataSynchronizationApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**sync_metadata**](MetadataSynchronizationApi.md#sync_metadata) | **POST** /api/v1/actions/organization/syncMetadata | Trigger metadata synchronization + + +# **sync_metadata** +> sync_metadata() + +Trigger metadata synchronization + +Enqueues an organization-scoped metadata resync, fanning out the organization's current metadata to GenAI, GW Forge, and Automations. Requires organization MANAGE permission. Requests are deduplicated while a resync session is pending for the organization. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import metadata_synchronization_api +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = metadata_synchronization_api.MetadataSynchronizationApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # Trigger metadata synchronization + api_instance.sync_metadata() + except gooddata_api_client.ApiException as e: + print("Exception when calling MetadataSynchronizationApi->sync_metadata: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/Metric.md b/gooddata-api-client/docs/Metric.md deleted file mode 100644 index 049008564..000000000 --- a/gooddata-api-client/docs/Metric.md +++ /dev/null @@ -1,16 +0,0 @@ -# Metric - -List of metrics to be used in the new visualization - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | ID of the object | -**title** | **str** | Title of metric. | -**type** | **str** | Object type | -**agg_function** | **str** | Agg function. Empty if a stored metric is used. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/MetricControllerApi.md b/gooddata-api-client/docs/MetricControllerApi.md index 5ee62007b..6af607027 100644 --- a/gooddata-api-client/docs/MetricControllerApi.md +++ b/gooddata-api-client/docs/MetricControllerApi.md @@ -44,7 +44,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricPostOptionalId( attributes=JsonApiMetricInAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -62,10 +77,10 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiMetricPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -212,7 +227,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -221,7 +236,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -308,11 +323,11 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -399,7 +414,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricPatch( attributes=JsonApiMetricPatchAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -418,7 +448,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiMetricPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -603,7 +633,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricIn( attributes=JsonApiMetricInAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -622,7 +667,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiMetricInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/MetricValueChange.md b/gooddata-api-client/docs/MetricValueChange.md index c76ed54cb..ef3adb148 100644 --- a/gooddata-api-client/docs/MetricValueChange.md +++ b/gooddata-api-client/docs/MetricValueChange.md @@ -5,7 +5,8 @@ Individual change analysis data item ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**attribute_name** | **str** | The name of the attribute being analyzed | +**attribute_name** | **str** | Deprecated: bare id of the analyzed label or computed attribute, without its type. Use attributeRef instead. | +**attribute_ref** | [**AfmObjectIdentifierLabel**](AfmObjectIdentifierLabel.md) | | **attribute_value** | **str** | The value of the attribute being analyzed | **attribute_values_change_mean** | **float** | The mean of attribute value changes for the attribute being analyzed | **attribute_values_change_std** | **float** | The standard deviation of attribute value changes for the attribute being analyzed | diff --git a/gooddata-api-client/docs/MetricsApi.md b/gooddata-api-client/docs/MetricsApi.md index 3ff19675f..74bcf29ee 100644 --- a/gooddata-api-client/docs/MetricsApi.md +++ b/gooddata-api-client/docs/MetricsApi.md @@ -44,7 +44,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricPostOptionalId( attributes=JsonApiMetricInAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -62,10 +77,10 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiMetricPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -212,7 +227,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -221,7 +236,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -308,11 +323,11 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -399,7 +414,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricPatch( attributes=JsonApiMetricPatchAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -418,7 +448,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiMetricPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -603,7 +633,22 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiMetricIn( attributes=JsonApiMetricInAttributes( are_relations_valid=True, - content=JsonApiMetricInAttributesContent( + conditional_formatting=JsonApiMetricInAttributesConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), + content=JsonApiComputedAttributeInAttributesContent( format="format_example", maql="maql_example", metric_type="UNSPECIFIED", @@ -622,7 +667,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiMetricInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/NotificationParameter.md b/gooddata-api-client/docs/NotificationParameter.md index 5dfa272eb..be604585f 100644 --- a/gooddata-api-client/docs/NotificationParameter.md +++ b/gooddata-api-client/docs/NotificationParameter.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes **id** | **str** | | **value** | **str** | | **title** | **str** | | [optional] +**value_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/ObjectConditionalFormatting.md b/gooddata-api-client/docs/ObjectConditionalFormatting.md new file mode 100644 index 000000000..2d5d094b7 --- /dev/null +++ b/gooddata-api-client/docs/ObjectConditionalFormatting.md @@ -0,0 +1,14 @@ +# ObjectConditionalFormatting + +Conditional formatting inherited by every table column that renders this object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conditions** | [**[ConditionalFormattingCondition]**](ConditionalFormattingCondition.md) | Conditions evaluated in order; the first match wins. | +**enabled** | **bool** | Whether the conditions are applied when rendering. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ObjectReference.md b/gooddata-api-client/docs/ObjectReference.md deleted file mode 100644 index a559f3bb5..000000000 --- a/gooddata-api-client/docs/ObjectReference.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectReference - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Object identifier (e.g. widget ID, metric ID). | -**type** | **str** | Type of the referenced object. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ObjectStorageInfo.md b/gooddata-api-client/docs/ObjectStorageInfo.md index 68c18c50e..36bb76fc8 100644 --- a/gooddata-api-client/docs/ObjectStorageInfo.md +++ b/gooddata-api-client/docs/ObjectStorageInfo.md @@ -5,7 +5,7 @@ Descriptor of a registered ObjectStorage. Provider credentials are stripped — ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds. | +**name** | **str** | Human-readable name. Pass `storageId` to ProvisionDatabase.storageIds. | **storage_config** | **{str: (str,)}** | Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side. | **storage_id** | **str** | Stable identifier of the storage configuration (UUID). | **storage_type** | **str** | Provider type. | diff --git a/gooddata-api-client/docs/AIObservabilityApi.md b/gooddata-api-client/docs/ObservabilityApi.md similarity index 78% rename from gooddata-api-client/docs/AIObservabilityApi.md rename to gooddata-api-client/docs/ObservabilityApi.md index 660f96b35..7e14bfce4 100644 --- a/gooddata-api-client/docs/AIObservabilityApi.md +++ b/gooddata-api-client/docs/ObservabilityApi.md @@ -1,10 +1,10 @@ -# gooddata_api_client.AIObservabilityApi +# gooddata_api_client.ObservabilityApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**reload_observability_layout**](AIObservabilityApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout +[**reload_observability_layout**](ObservabilityApi.md#reload_observability_layout) | **POST** /api/v1/actions/organization/reloadObservabilityLayout | Reload the managed AI observability layout # **reload_observability_layout** @@ -20,7 +20,7 @@ Re-applies the latest GoodData-managed AI observability layout to the organizati ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_observability_api +from gooddata_api_client.api import observability_api from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -32,14 +32,14 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_observability_api.AIObservabilityApi(api_client) + api_instance = observability_api.ObservabilityApi(api_client) # example, this endpoint has no required or optional parameters try: # Reload the managed AI observability layout api_instance.reload_observability_layout() except gooddata_api_client.ApiException as e: - print("Exception when calling AIObservabilityApi->reload_observability_layout: %s\n" % e) + print("Exception when calling ObservabilityApi->reload_observability_layout: %s\n" % e) ``` diff --git a/gooddata-api-client/docs/Operation.md b/gooddata-api-client/docs/Operation.md index bbf2e0ffc..2e33f9f83 100644 --- a/gooddata-api-client/docs/Operation.md +++ b/gooddata-api-client/docs/Operation.md @@ -6,7 +6,7 @@ Represents a Long-Running Operation: a process that takes some time to complete. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | **status** | **str** | | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md index 9fdf84cdc..b8e766115 100644 --- a/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/OrganizationDeclarativeAPIsApi.md @@ -251,6 +251,14 @@ with gooddata_api_client.ApiClient() as api_client: description="description_example", enabled=True, id="default-ai-assistant", + instructions=[ + Instruction( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -423,6 +431,14 @@ with gooddata_api_client.ApiClient() as api_client: description="description_example", enabled=True, id="default-ai-assistant", + instructions=[ + Instruction( + content="content_example", + is_disabled=True, + strategy="ALWAYS", + title="title_example", + ), + ], modified_at="2023-07-20 12:30", modified_by=DeclarativeUserIdentifier( id="employee123", @@ -461,6 +477,7 @@ with gooddata_api_client.ApiClient() as api_client: value="value_example", ), ], + disable_statistics=True, id="pg_local_docker-demo", name="postgres demo", parameters=[ @@ -790,6 +807,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -988,6 +1010,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -1267,6 +1310,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -1347,6 +1426,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -1385,6 +1479,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -1394,6 +1526,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -1464,6 +1617,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -1474,6 +1642,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -1589,6 +1772,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", diff --git a/gooddata-api-client/docs/ParameterValue.md b/gooddata-api-client/docs/ParameterValue.md index 8d7bd3181..b44bc7f46 100644 --- a/gooddata-api-client/docs/ParameterValue.md +++ b/gooddata-api-client/docs/ParameterValue.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes **id** | **str** | Identifier of the workspace parameter (matches the parameter entity id). | **title** | **str** | Display title of the parameter as the client wants it rendered on the info sheet. | **value** | **str** | Value to use for this parameter when executing the export. | +**value_title** | **str** | Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent. | [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/PartitionConfig.md b/gooddata-api-client/docs/PartitionConfig.md deleted file mode 100644 index f080742f8..000000000 --- a/gooddata-api-client/docs/PartitionConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -# PartitionConfig - -Partition configuration for the table. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/PendingOperation.md b/gooddata-api-client/docs/PendingOperation.md index 5af957237..3c048f44d 100644 --- a/gooddata-api-client/docs/PendingOperation.md +++ b/gooddata-api-client/docs/PendingOperation.md @@ -6,7 +6,7 @@ Operation that is still pending Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | **status** | **str** | | defaults to "pending" **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/PermissionsApi.md b/gooddata-api-client/docs/PermissionsApi.md index e04c28cce..b1ba04595 100644 --- a/gooddata-api-client/docs/PermissionsApi.md +++ b/gooddata-api-client/docs/PermissionsApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**attribute_permissions**](PermissionsApi.md#attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions | Get Attribute Permissions [**available_assignees**](PermissionsApi.md#available_assignees) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees | Get Available Assignees +[**computed_attribute_permissions**](PermissionsApi.md#computed_attribute_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions | (BETA) Get Computed Attribute Permissions [**dashboard_permissions**](PermissionsApi.md#dashboard_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions | Get Dashboard Permissions [**fact_permissions**](PermissionsApi.md#fact_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions | Get Fact Permissions [**get_organization_permissions**](PermissionsApi.md#get_organization_permissions) | **GET** /api/v1/layout/organization/permissions | Get organization permissions @@ -14,18 +15,21 @@ Method | HTTP request | Description [**get_workspace_permissions**](PermissionsApi.md#get_workspace_permissions) | **GET** /api/v1/layout/workspaces/{workspaceId}/permissions | Get permissions for the workspace [**label_permissions**](PermissionsApi.md#label_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions | Get Label Permissions [**manage_attribute_permissions**](PermissionsApi.md#manage_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions | Manage Permissions for an Attribute +[**manage_computed_attribute_permissions**](PermissionsApi.md#manage_computed_attribute_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions | (BETA) Manage Permissions for a Computed Attribute [**manage_dashboard_permissions**](PermissionsApi.md#manage_dashboard_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions | Manage Permissions for a Dashboard [**manage_data_source_permissions**](PermissionsApi.md#manage_data_source_permissions) | **POST** /api/v1/actions/dataSources/{dataSourceId}/managePermissions | Manage Permissions for a Data Source [**manage_fact_permissions**](PermissionsApi.md#manage_fact_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions | Manage Permissions for a Fact [**manage_label_permissions**](PermissionsApi.md#manage_label_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions | Manage Permissions for a Label [**manage_metric_permissions**](PermissionsApi.md#manage_metric_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions | (BETA) Manage Permissions for a Metric [**manage_organization_permissions**](PermissionsApi.md#manage_organization_permissions) | **POST** /api/v1/actions/organization/managePermissions | Manage Permissions for a Organization +[**manage_visualization_permissions**](PermissionsApi.md#manage_visualization_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions | (BETA) Manage Permissions for a Visualization [**manage_workspace_permissions**](PermissionsApi.md#manage_workspace_permissions) | **POST** /api/v1/actions/workspaces/{workspaceId}/managePermissions | Manage Permissions for a Workspace [**metric_permissions**](PermissionsApi.md#metric_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions | (BETA) Get Metric Permissions [**set_organization_permissions**](PermissionsApi.md#set_organization_permissions) | **PUT** /api/v1/layout/organization/permissions | Set organization permissions [**set_user_group_permissions**](PermissionsApi.md#set_user_group_permissions) | **PUT** /api/v1/layout/userGroups/{userGroupId}/permissions | Set permissions for the user-group [**set_user_permissions**](PermissionsApi.md#set_user_permissions) | **PUT** /api/v1/layout/users/{userId}/permissions | Set permissions for the user [**set_workspace_permissions**](PermissionsApi.md#set_workspace_permissions) | **PUT** /api/v1/layout/workspaces/{workspaceId}/permissions | Set permissions for the workspace +[**visualization_permissions**](PermissionsApi.md#visualization_permissions) | **GET** /api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions | (BETA) Get Visualization Permissions # **attribute_permissions** @@ -154,6 +158,73 @@ No authorization required - **Accept**: application/json +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **computed_attribute_permissions** +> ComputedAttributePermissions computed_attribute_permissions(workspace_id, computed_attribute_id) + +(BETA) Get Computed Attribute Permissions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import permissions_api +from gooddata_api_client.model.computed_attribute_permissions import ComputedAttributePermissions +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = permissions_api.PermissionsApi(api_client) + workspace_id = "workspaceId_example" # str | + computed_attribute_id = "computedAttributeId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Get Computed Attribute Permissions + api_response = api_instance.computed_attribute_permissions(workspace_id, computed_attribute_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PermissionsApi->computed_attribute_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **computed_attribute_id** | **str**| | + +### Return type + +[**ComputedAttributePermissions**](ComputedAttributePermissions.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + ### HTTP response details | Status code | Description | Response headers | @@ -689,6 +760,76 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **manage_computed_attribute_permissions** +> manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) + +(BETA) Manage Permissions for a Computed Attribute + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import permissions_api +from gooddata_api_client.model.manage_computed_attribute_permissions_request_inner import ManageComputedAttributePermissionsRequestInner +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = permissions_api.PermissionsApi(api_client) + workspace_id = "workspaceId_example" # str | + computed_attribute_id = "computedAttributeId_example" # str | + manage_computed_attribute_permissions_request_inner = [ + ManageComputedAttributePermissionsRequestInner(None), + ] # [ManageComputedAttributePermissionsRequestInner] | + + # example passing only required values which don't have defaults set + try: + # (BETA) Manage Permissions for a Computed Attribute + api_instance.manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner) + except gooddata_api_client.ApiException as e: + print("Exception when calling PermissionsApi->manage_computed_attribute_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **computed_attribute_id** | **str**| | + **manage_computed_attribute_permissions_request_inner** | [**[ManageComputedAttributePermissionsRequestInner]**](ManageComputedAttributePermissionsRequestInner.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -1123,6 +1264,76 @@ No authorization required - **Accept**: Not defined +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **manage_visualization_permissions** +> manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) + +(BETA) Manage Permissions for a Visualization + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import permissions_api +from gooddata_api_client.model.manage_visualization_permissions_request_inner import ManageVisualizationPermissionsRequestInner +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = permissions_api.PermissionsApi(api_client) + workspace_id = "workspaceId_example" # str | + visualization_object_id = "visualizationObjectId_example" # str | + manage_visualization_permissions_request_inner = [ + ManageVisualizationPermissionsRequestInner(None), + ] # [ManageVisualizationPermissionsRequestInner] | + + # example passing only required values which don't have defaults set + try: + # (BETA) Manage Permissions for a Visualization + api_instance.manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner) + except gooddata_api_client.ApiException as e: + print("Exception when calling PermissionsApi->manage_visualization_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **visualization_object_id** | **str**| | + **manage_visualization_permissions_request_inner** | [**[ManageVisualizationPermissionsRequestInner]**](ManageVisualizationPermissionsRequestInner.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + ### HTTP response details | Status code | Description | Response headers | @@ -1596,3 +1807,70 @@ 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) +# **visualization_permissions** +> VisualizationPermissions visualization_permissions(workspace_id, visualization_object_id) + +(BETA) Get Visualization Permissions + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import permissions_api +from gooddata_api_client.model.visualization_permissions import VisualizationPermissions +from pprint import pprint +# Defining the host is optional and defaults to http://localhost +# See configuration.py for a list of all supported configuration parameters. +configuration = gooddata_api_client.Configuration( + host = "http://localhost" +) + + +# Enter a context with an instance of the API client +with gooddata_api_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = permissions_api.PermissionsApi(api_client) + workspace_id = "workspaceId_example" # str | + visualization_object_id = "visualizationObjectId_example" # str | + + # example passing only required values which don't have defaults set + try: + # (BETA) Get Visualization Permissions + api_response = api_instance.visualization_permissions(workspace_id, visualization_object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling PermissionsApi->visualization_permissions: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **visualization_object_id** | **str**| | + +### Return type + +[**VisualizationPermissions**](VisualizationPermissions.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/PipeTable.md b/gooddata-api-client/docs/PipeTable.md deleted file mode 100644 index 4094c65bf..000000000 --- a/gooddata-api-client/docs/PipeTable.md +++ /dev/null @@ -1,24 +0,0 @@ -# PipeTable - -Full details of a pipe-backed OLAP table - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | [**[ColumnInfo]**](ColumnInfo.md) | Inferred column schema | -**database_name** | **str** | Database name | -**distribution_config** | [**CreatePipeTableRequestDistributionConfig**](CreatePipeTableRequestDistributionConfig.md) | | -**key_config** | [**CreatePipeTableRequestKeyConfig**](CreatePipeTableRequestKeyConfig.md) | | -**partition_columns** | **[str]** | Hive partition columns detected from the path structure | -**path_prefix** | **str** | Path prefix to the parquet files | -**pipe_table_id** | **str** | Internal UUID of the pipe table record | -**polling_interval_seconds** | **int** | How often (in seconds) the pipe polls for new files. 0 = server default. | -**source_storage_name** | **str** | Source ObjectStorage name | -**table_name** | **str** | OLAP table name | -**table_properties** | **{str: (str,)}** | CREATE TABLE PROPERTIES key-value pairs | -**partition_config** | [**CreatePipeTableRequestPartitionConfig**](CreatePipeTableRequestPartitionConfig.md) | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/PipeTableSummary.md b/gooddata-api-client/docs/PipeTableSummary.md deleted file mode 100644 index de02d132f..000000000 --- a/gooddata-api-client/docs/PipeTableSummary.md +++ /dev/null @@ -1,16 +0,0 @@ -# PipeTableSummary - -Lightweight pipe table entry used in list responses - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**columns** | [**[ColumnInfo]**](ColumnInfo.md) | Inferred column schema | -**path_prefix** | **str** | Path prefix to the parquet files | -**pipe_table_id** | **str** | Internal UUID of the pipe table record | -**table_name** | **str** | OLAP table 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/RandomDistributionConfig.md b/gooddata-api-client/docs/RandomDistributionConfig.md deleted file mode 100644 index 85320054e..000000000 --- a/gooddata-api-client/docs/RandomDistributionConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# RandomDistributionConfig - -Random distribution across buckets. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "random" -**buckets** | **int** | Number of random distribution buckets. Defaults to 1. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/Reasoning.md b/gooddata-api-client/docs/Reasoning.md deleted file mode 100644 index 6c60c1b38..000000000 --- a/gooddata-api-client/docs/Reasoning.md +++ /dev/null @@ -1,14 +0,0 @@ -# Reasoning - -Reasoning wrapper containing steps taken during request handling. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**steps** | [**[ReasoningStep]**](ReasoningStep.md) | Steps taken during processing, showing the AI's reasoning process. | -**answer** | **str** | Final answer/reasoning from the use case result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ReasoningStep.md b/gooddata-api-client/docs/ReasoningStep.md deleted file mode 100644 index 090920705..000000000 --- a/gooddata-api-client/docs/ReasoningStep.md +++ /dev/null @@ -1,14 +0,0 @@ -# ReasoningStep - -Steps taken during processing, showing the AI's reasoning process. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**thoughts** | [**[Thought]**](Thought.md) | Detailed thoughts/messages within this step. | -**title** | **str** | Title describing this reasoning step. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/RefreshPartitionRequest.md b/gooddata-api-client/docs/RefreshPartitionRequest.md deleted file mode 100644 index 853753266..000000000 --- a/gooddata-api-client/docs/RefreshPartitionRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# RefreshPartitionRequest - -Request to refresh a specific Hive partition in a pipe-backed OLAP table - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**partition_spec** | **{str: (str,)}** | Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"} | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ReportControllerApi.md b/gooddata-api-client/docs/ReportControllerApi.md new file mode 100644 index 000000000..b81e618aa --- /dev/null +++ b/gooddata-api-client/docs/ReportControllerApi.md @@ -0,0 +1,569 @@ +# gooddata_api_client.ReportControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_reports**](ReportControllerApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report +[**delete_entity_reports**](ReportControllerApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report +[**get_all_entities_reports**](ReportControllerApi.md#get_all_entities_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports | Get all Reports +[**get_entity_reports**](ReportControllerApi.md#get_entity_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Get a Report +[**patch_entity_reports**](ReportControllerApi.md#patch_entity_reports) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Patch a Report +[**update_entity_reports**](ReportControllerApi.md#update_entity_reports) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Put a Report + + +# **create_entity_reports** +> JsonApiReportOutDocument create_entity_reports(workspace_id, json_api_report_post_optional_id_document) + +Post Report + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_controller_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument +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_controller_api.ReportControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_report_post_optional_id_document = JsonApiReportPostOptionalIdDocument( + data=JsonApiReportPostOptionalId( + attributes=JsonApiReportInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", + ], + title="title_example", + variable_values=None, + ), + id="id1", + type="report", + ), + ) # JsonApiReportPostOptionalIdDocument | + 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 Report + api_response = api_instance.create_entity_reports(workspace_id, json_api_report_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->create_entity_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Report + api_response = api_instance.create_entity_reports(workspace_id, json_api_report_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->create_entity_reports: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_report_post_optional_id_document** | [**JsonApiReportPostOptionalIdDocument**](JsonApiReportPostOptionalIdDocument.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 + +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.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_reports** +> delete_entity_reports(workspace_id, object_id) + +Delete a Report + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_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 = report_controller_api.ReportControllerApi(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 Report + api_instance.delete_entity_reports(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->delete_entity_reports: %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_reports** +> JsonApiReportOutList get_all_entities_reports(workspace_id) + +Get all Reports + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_controller_api +from gooddata_api_client.model.json_api_report_out_list import JsonApiReportOutList +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_controller_api.ReportControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;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 Reports + api_response = api_instance.get_all_entities_reports(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->get_all_entities_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Reports + api_response = api_instance.get_all_entities_reports(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 ReportControllerApi->get_all_entities_reports: %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 + +[**JsonApiReportOutList**](JsonApiReportOutList.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_reports** +> JsonApiReportOutDocument get_entity_reports(workspace_id, object_id) + +Get a Report + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_controller_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +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_controller_api.ReportControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Report + api_response = api_instance.get_entity_reports(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->get_entity_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Report + api_response = api_instance.get_entity_reports(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 ReportControllerApi->get_entity_reports: %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 + +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.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_reports** +> JsonApiReportOutDocument patch_entity_reports(workspace_id, object_id, json_api_report_patch_document) + +Patch a Report + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_controller_api +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +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_controller_api.ReportControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_patch_document = JsonApiReportPatchDocument( + data=JsonApiReportPatch( + attributes=JsonApiReportPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", + ], + title="title_example", + variable_values=None, + ), + id="id1", + type="report", + ), + ) # JsonApiReportPatchDocument | + 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 Report + api_response = api_instance.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->patch_entity_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Report + api_response = api_instance.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->patch_entity_reports: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_patch_document** | [**JsonApiReportPatchDocument**](JsonApiReportPatchDocument.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 + +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.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_reports** +> JsonApiReportOutDocument update_entity_reports(workspace_id, object_id, json_api_report_in_document) + +Put a Report + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_controller_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_in_document import JsonApiReportInDocument +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_controller_api.ReportControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_in_document = JsonApiReportInDocument( + data=JsonApiReportIn( + attributes=JsonApiReportInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", + ], + title="title_example", + variable_values=None, + ), + id="id1", + type="report", + ), + ) # JsonApiReportInDocument | + 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 Report + api_response = api_instance.update_entity_reports(workspace_id, object_id, json_api_report_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->update_entity_reports: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Report + api_response = api_instance.update_entity_reports(workspace_id, object_id, json_api_report_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportControllerApi->update_entity_reports: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_in_document** | [**JsonApiReportInDocument**](JsonApiReportInDocument.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 + +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.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/ReportExportApi.md b/gooddata-api-client/docs/ReportExportApi.md new file mode 100644 index 000000000..5137a4de6 --- /dev/null +++ b/gooddata-api-client/docs/ReportExportApi.md @@ -0,0 +1,235 @@ +# gooddata_api_client.ReportExportApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_report_export**](ReportExportApi.md#create_report_export) | **POST** /api/v1/actions/workspaces/{workspaceId}/export/report | (EXPERIMENTAL) Create report export request +[**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_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. + +### 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( + 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 report export request + api_response = api_instance.create_report_export(workspace_id, report_export_request) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->create_report_export: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # (EXPERIMENTAL) Create report export request + api_response = api_instance.create_report_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_report_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** | Report 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) + +# **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. + +### Example + + +```python +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 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 files + api_response = api_instance.get_report_export(workspace_id, export_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->get_report_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_report_export_metadata** +> get_report_export_metadata(workspace_id, export_id) + +(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. + +### 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 metadata context + api_instance.get_report_export_metadata(workspace_id, export_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportExportApi->get_report_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) + diff --git a/gooddata-api-client/docs/ReportExportRequest.md b/gooddata-api-client/docs/ReportExportRequest.md new file mode 100644 index 000000000..cc3fe7cc3 --- /dev/null +++ b/gooddata-api-client/docs/ReportExportRequest.md @@ -0,0 +1,17 @@ +# ReportExportRequest + +Export request object describing the export properties and metadata for report 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" +**metadata** | [**JsonNode**](JsonNode.md) | | [optional] +**timezone_id** | **str, none_type** | Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used. | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/ReportPageLayoutControllerApi.md b/gooddata-api-client/docs/ReportPageLayoutControllerApi.md new file mode 100644 index 000000000..03cac3289 --- /dev/null +++ b/gooddata-api-client/docs/ReportPageLayoutControllerApi.md @@ -0,0 +1,560 @@ +# gooddata_api_client.ReportPageLayoutControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_report_page_layouts**](ReportPageLayoutControllerApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout +[**delete_entity_report_page_layouts**](ReportPageLayoutControllerApi.md#delete_entity_report_page_layouts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Delete a Report Page Layout +[**get_all_entities_report_page_layouts**](ReportPageLayoutControllerApi.md#get_all_entities_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Get all Report Page Layouts +[**get_entity_report_page_layouts**](ReportPageLayoutControllerApi.md#get_entity_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Get a Report Page Layout +[**patch_entity_report_page_layouts**](ReportPageLayoutControllerApi.md#patch_entity_report_page_layouts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Patch a Report Page Layout +[**update_entity_report_page_layouts**](ReportPageLayoutControllerApi.md#update_entity_report_page_layouts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Put a Report Page Layout + + +# **create_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document) + +Post Report Page Layout + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_page_layout_controller_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument +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_page_layout_controller_api.ReportPageLayoutControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_report_page_layout_post_optional_id_document = JsonApiReportPageLayoutPostOptionalIdDocument( + data=JsonApiReportPageLayoutPostOptionalId( + attributes=JsonApiReportPageLayoutInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportPageLayout", + ), + ) # JsonApiReportPageLayoutPostOptionalIdDocument | + 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 Report Page Layout + api_response = api_instance.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->create_entity_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Report Page Layout + api_response = api_instance.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document, include=include, meta_include=meta_include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->create_entity_report_page_layouts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_report_page_layout_post_optional_id_document** | [**JsonApiReportPageLayoutPostOptionalIdDocument**](JsonApiReportPageLayoutPostOptionalIdDocument.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 + +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.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_report_page_layouts** +> delete_entity_report_page_layouts(workspace_id, object_id) + +Delete a Report Page Layout + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_page_layout_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 = report_page_layout_controller_api.ReportPageLayoutControllerApi(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 Report Page Layout + api_instance.delete_entity_report_page_layouts(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->delete_entity_report_page_layouts: %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_report_page_layouts** +> JsonApiReportPageLayoutOutList get_all_entities_report_page_layouts(workspace_id) + +Get all Report Page Layouts + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_page_layout_controller_api +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList +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_page_layout_controller_api.ReportPageLayoutControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;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 Report Page Layouts + api_response = api_instance.get_all_entities_report_page_layouts(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->get_all_entities_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Report Page Layouts + api_response = api_instance.get_all_entities_report_page_layouts(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 ReportPageLayoutControllerApi->get_all_entities_report_page_layouts: %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 + +[**JsonApiReportPageLayoutOutList**](JsonApiReportPageLayoutOutList.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_report_page_layouts** +> JsonApiReportPageLayoutOutDocument get_entity_report_page_layouts(workspace_id, object_id) + +Get a Report Page Layout + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_page_layout_controller_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +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_page_layout_controller_api.ReportPageLayoutControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Report Page Layout + api_response = api_instance.get_entity_report_page_layouts(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->get_entity_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Report Page Layout + api_response = api_instance.get_entity_report_page_layouts(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 ReportPageLayoutControllerApi->get_entity_report_page_layouts: %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 + +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.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_report_page_layouts** +> JsonApiReportPageLayoutOutDocument patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document) + +Patch a Report Page Layout + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_page_layout_controller_api +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +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_page_layout_controller_api.ReportPageLayoutControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_page_layout_patch_document = JsonApiReportPageLayoutPatchDocument( + data=JsonApiReportPageLayoutPatch( + attributes=JsonApiReportPageLayoutPatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportPageLayout", + ), + ) # JsonApiReportPageLayoutPatchDocument | + 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 Report Page Layout + api_response = api_instance.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->patch_entity_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Report Page Layout + api_response = api_instance.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->patch_entity_report_page_layouts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_page_layout_patch_document** | [**JsonApiReportPageLayoutPatchDocument**](JsonApiReportPageLayoutPatchDocument.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 + +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.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_report_page_layouts** +> JsonApiReportPageLayoutOutDocument update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document) + +Put a Report Page Layout + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_page_layout_controller_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_in_document import JsonApiReportPageLayoutInDocument +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_page_layout_controller_api.ReportPageLayoutControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_page_layout_in_document = JsonApiReportPageLayoutInDocument( + data=JsonApiReportPageLayoutIn( + attributes=JsonApiReportPageLayoutInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportPageLayout", + ), + ) # JsonApiReportPageLayoutInDocument | + 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 Report Page Layout + api_response = api_instance.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->update_entity_report_page_layouts: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Report Page Layout + api_response = api_instance.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportPageLayoutControllerApi->update_entity_report_page_layouts: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_page_layout_in_document** | [**JsonApiReportPageLayoutInDocument**](JsonApiReportPageLayoutInDocument.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 + +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.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/ReportTemplateControllerApi.md b/gooddata-api-client/docs/ReportTemplateControllerApi.md new file mode 100644 index 000000000..9e8e19100 --- /dev/null +++ b/gooddata-api-client/docs/ReportTemplateControllerApi.md @@ -0,0 +1,560 @@ +# gooddata_api_client.ReportTemplateControllerApi + +All URIs are relative to *http://localhost* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_entity_report_templates**](ReportTemplateControllerApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template +[**delete_entity_report_templates**](ReportTemplateControllerApi.md#delete_entity_report_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Delete a Report Template +[**get_all_entities_report_templates**](ReportTemplateControllerApi.md#get_all_entities_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Get all Report Templates +[**get_entity_report_templates**](ReportTemplateControllerApi.md#get_entity_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Get a Report Template +[**patch_entity_report_templates**](ReportTemplateControllerApi.md#patch_entity_report_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Patch a Report Template +[**update_entity_report_templates**](ReportTemplateControllerApi.md#update_entity_report_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Put a Report Template + + +# **create_entity_report_templates** +> JsonApiReportTemplateOutDocument create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document) + +Post Report Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_template_controller_api +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +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_template_controller_api.ReportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_report_template_post_optional_id_document = JsonApiReportTemplatePostOptionalIdDocument( + data=JsonApiReportTemplatePostOptionalId( + attributes=JsonApiReportTemplateInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportTemplate", + ), + ) # JsonApiReportTemplatePostOptionalIdDocument | + 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 Report Template + api_response = api_instance.create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->create_entity_report_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Post Report Template + api_response = api_instance.create_entity_report_templates(workspace_id, json_api_report_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 ReportTemplateControllerApi->create_entity_report_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **json_api_report_template_post_optional_id_document** | [**JsonApiReportTemplatePostOptionalIdDocument**](JsonApiReportTemplatePostOptionalIdDocument.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 + +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.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_report_templates** +> delete_entity_report_templates(workspace_id, object_id) + +Delete a Report Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_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 = report_template_controller_api.ReportTemplateControllerApi(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 Report Template + api_instance.delete_entity_report_templates(workspace_id, object_id) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->delete_entity_report_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_report_templates** +> JsonApiReportTemplateOutList get_all_entities_report_templates(workspace_id) + +Get all Report Templates + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_template_controller_api +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList +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_template_controller_api.ReportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" + filter = "title==someString;description==someString;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 Report Templates + api_response = api_instance.get_all_entities_report_templates(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->get_all_entities_report_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get all Report Templates + api_response = api_instance.get_all_entities_report_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 ReportTemplateControllerApi->get_all_entities_report_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 + +[**JsonApiReportTemplateOutList**](JsonApiReportTemplateOutList.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_report_templates** +> JsonApiReportTemplateOutDocument get_entity_report_templates(workspace_id, object_id) + +Get a Report Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_template_controller_api +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +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_template_controller_api.ReportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + include = [ + "createdBy,modifiedBy", + ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) + + # example passing only required values which don't have defaults set + try: + # Get a Report Template + api_response = api_instance.get_entity_report_templates(workspace_id, object_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->get_entity_report_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Get a Report Template + api_response = api_instance.get_entity_report_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 ReportTemplateControllerApi->get_entity_report_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 + +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.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_report_templates** +> JsonApiReportTemplateOutDocument patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document) + +Patch a Report Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_template_controller_api +from gooddata_api_client.model.json_api_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +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_template_controller_api.ReportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_template_patch_document = JsonApiReportTemplatePatchDocument( + data=JsonApiReportTemplatePatch( + attributes=JsonApiReportTemplatePatchAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportTemplate", + ), + ) # JsonApiReportTemplatePatchDocument | + 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 Report Template + api_response = api_instance.patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->patch_entity_report_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Patch a Report Template + api_response = api_instance.patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->patch_entity_report_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_template_patch_document** | [**JsonApiReportTemplatePatchDocument**](JsonApiReportTemplatePatchDocument.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 + +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.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_report_templates** +> JsonApiReportTemplateOutDocument update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document) + +Put a Report Template + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import report_template_controller_api +from gooddata_api_client.model.json_api_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +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_template_controller_api.ReportTemplateControllerApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_template_in_document = JsonApiReportTemplateInDocument( + data=JsonApiReportTemplateIn( + attributes=JsonApiReportTemplateInAttributes( + are_relations_valid=True, + content={}, + description="description_example", + tags=[ + "tags_example", + ], + title="title_example", + ), + id="id1", + type="reportTemplate", + ), + ) # JsonApiReportTemplateInDocument | + 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 Report Template + api_response = api_instance.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->update_entity_report_templates: %s\n" % e) + + # example passing only required values which don't have defaults set + # and optional values + try: + # Put a Report Template + api_response = api_instance.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document, filter=filter, include=include) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportTemplateControllerApi->update_entity_report_templates: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_template_in_document** | [**JsonApiReportTemplateInDocument**](JsonApiReportTemplateInDocument.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 + +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.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/AIApi.md b/gooddata-api-client/docs/ReportsApi.md similarity index 62% rename from gooddata-api-client/docs/AIApi.md rename to gooddata-api-client/docs/ReportsApi.md index e3706dcb6..c639b4bd8 100644 --- a/gooddata-api-client/docs/AIApi.md +++ b/gooddata-api-client/docs/ReportsApi.md @@ -1,35 +1,33 @@ -# gooddata_api_client.AIApi +# gooddata_api_client.ReportsApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create_entity_knowledge_recommendations**](AIApi.md#create_entity_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Post Knowledge Recommendations -[**create_entity_memory_items**](AIApi.md#create_entity_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Post Memory Items -[**create_entity_org_memory_items**](AIApi.md#create_entity_org_memory_items) | **POST** /api/v1/entities/orgMemoryItems | Post organization Memory Item entities -[**delete_entity_knowledge_recommendations**](AIApi.md#delete_entity_knowledge_recommendations) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Delete a Knowledge Recommendation -[**delete_entity_memory_items**](AIApi.md#delete_entity_memory_items) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Delete a Memory Item -[**delete_entity_org_memory_items**](AIApi.md#delete_entity_org_memory_items) | **DELETE** /api/v1/entities/orgMemoryItems/{id} | Delete an organization Memory Item entity -[**get_all_entities_knowledge_recommendations**](AIApi.md#get_all_entities_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations | Get all Knowledge Recommendations -[**get_all_entities_memory_items**](AIApi.md#get_all_entities_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems | Get all Memory Items -[**get_all_entities_org_memory_items**](AIApi.md#get_all_entities_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems | Get all organization Memory Item entities -[**get_entity_knowledge_recommendations**](AIApi.md#get_entity_knowledge_recommendations) | **GET** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Get a Knowledge Recommendation -[**get_entity_memory_items**](AIApi.md#get_entity_memory_items) | **GET** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Get a Memory Item -[**get_entity_org_memory_items**](AIApi.md#get_entity_org_memory_items) | **GET** /api/v1/entities/orgMemoryItems/{id} | Get an organization Memory Item entity -[**patch_entity_knowledge_recommendations**](AIApi.md#patch_entity_knowledge_recommendations) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Patch a Knowledge Recommendation -[**patch_entity_memory_items**](AIApi.md#patch_entity_memory_items) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Patch a Memory Item -[**patch_entity_org_memory_items**](AIApi.md#patch_entity_org_memory_items) | **PATCH** /api/v1/entities/orgMemoryItems/{id} | Patch an organization Memory Item entity -[**search_entities_knowledge_recommendations**](AIApi.md#search_entities_knowledge_recommendations) | **POST** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search | The search endpoint (beta) -[**search_entities_memory_items**](AIApi.md#search_entities_memory_items) | **POST** /api/v1/entities/workspaces/{workspaceId}/memoryItems/search | The search endpoint (beta) -[**update_entity_knowledge_recommendations**](AIApi.md#update_entity_knowledge_recommendations) | **PUT** /api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId} | Put a Knowledge Recommendation -[**update_entity_memory_items**](AIApi.md#update_entity_memory_items) | **PUT** /api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId} | Put a Memory Item -[**update_entity_org_memory_items**](AIApi.md#update_entity_org_memory_items) | **PUT** /api/v1/entities/orgMemoryItems/{id} | Put an organization Memory Item entity - - -# **create_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) - -Post Knowledge Recommendations +[**create_entity_report_page_layouts**](ReportsApi.md#create_entity_report_page_layouts) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Post Report Page Layout +[**create_entity_report_templates**](ReportsApi.md#create_entity_report_templates) | **POST** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Post Report Template +[**create_entity_reports**](ReportsApi.md#create_entity_reports) | **POST** /api/v1/entities/workspaces/{workspaceId}/reports | Post Report +[**delete_entity_report_page_layouts**](ReportsApi.md#delete_entity_report_page_layouts) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Delete a Report Page Layout +[**delete_entity_report_templates**](ReportsApi.md#delete_entity_report_templates) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Delete a Report Template +[**delete_entity_reports**](ReportsApi.md#delete_entity_reports) | **DELETE** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Delete a Report +[**get_all_entities_report_page_layouts**](ReportsApi.md#get_all_entities_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts | Get all Report Page Layouts +[**get_all_entities_report_templates**](ReportsApi.md#get_all_entities_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates | Get all Report Templates +[**get_all_entities_reports**](ReportsApi.md#get_all_entities_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports | Get all Reports +[**get_entity_report_page_layouts**](ReportsApi.md#get_entity_report_page_layouts) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Get a Report Page Layout +[**get_entity_report_templates**](ReportsApi.md#get_entity_report_templates) | **GET** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Get a Report Template +[**get_entity_reports**](ReportsApi.md#get_entity_reports) | **GET** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Get a Report +[**patch_entity_report_page_layouts**](ReportsApi.md#patch_entity_report_page_layouts) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Patch a Report Page Layout +[**patch_entity_report_templates**](ReportsApi.md#patch_entity_report_templates) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Patch a Report Template +[**patch_entity_reports**](ReportsApi.md#patch_entity_reports) | **PATCH** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Patch a Report +[**update_entity_report_page_layouts**](ReportsApi.md#update_entity_report_page_layouts) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId} | Put a Report Page Layout +[**update_entity_report_templates**](ReportsApi.md#update_entity_report_templates) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId} | Put a Report Template +[**update_entity_reports**](ReportsApi.md#update_entity_reports) | **PUT** /api/v1/entities/workspaces/{workspaceId}/reports/{objectId} | Put a Report + + +# **create_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document) + +Post Report Page Layout ### Example @@ -37,9 +35,9 @@ Post Knowledge Recommendations ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument 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. @@ -51,45 +49,25 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_knowledge_recommendation_post_optional_id_document = JsonApiKnowledgeRecommendationPostOptionalIdDocument( - data=JsonApiKnowledgeRecommendationPostOptionalId( - attributes=JsonApiKnowledgeRecommendationInAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, + json_api_report_page_layout_post_optional_id_document = JsonApiReportPageLayoutPostOptionalIdDocument( + data=JsonApiReportPageLayoutPostOptionalId( + attributes=JsonApiReportPageLayoutInAttributes( are_relations_valid=True, - comparison_type="MONTH", - confidence=None, + content={}, description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, tags=[ "tags_example", ], title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", ), id="id1", - relationships=JsonApiKnowledgeRecommendationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", + type="reportPageLayout", ), - ) # JsonApiKnowledgeRecommendationPostOptionalIdDocument | + ) # JsonApiReportPageLayoutPostOptionalIdDocument | include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ "metaInclude=origin,all", @@ -97,20 +75,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Post Knowledge Recommendations - api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document) + # Post Report Page Layout + api_response = api_instance.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->create_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->create_entity_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Knowledge Recommendations - api_response = api_instance.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, include=include, meta_include=meta_include) + # Post Report Page Layout + api_response = api_instance.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->create_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->create_entity_report_page_layouts: %s\n" % e) ``` @@ -119,13 +97,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_knowledge_recommendation_post_optional_id_document** | [**JsonApiKnowledgeRecommendationPostOptionalIdDocument**](JsonApiKnowledgeRecommendationPostOptionalIdDocument.md)| | + **json_api_report_page_layout_post_optional_id_document** | [**JsonApiReportPageLayoutPostOptionalIdDocument**](JsonApiReportPageLayoutPostOptionalIdDocument.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 -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -145,10 +123,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_memory_items** -> JsonApiMemoryItemOutDocument create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) +# **create_entity_report_templates** +> JsonApiReportTemplateOutDocument create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document) -Post Memory Items +Post Report Template ### Example @@ -156,9 +134,9 @@ Post Memory Items ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -170,28 +148,23 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | - json_api_memory_item_post_optional_id_document = JsonApiMemoryItemPostOptionalIdDocument( - data=JsonApiMemoryItemPostOptionalId( - attributes=JsonApiMemoryItemInAttributes( + json_api_report_template_post_optional_id_document = JsonApiReportTemplatePostOptionalIdDocument( + data=JsonApiReportTemplatePostOptionalId( + attributes=JsonApiReportTemplateInAttributes( are_relations_valid=True, + content={}, description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", - ], - strategy="ALWAYS", tags=[ "tags_example", ], title="title_example", ), id="id1", - type="memoryItem", + type="reportTemplate", ), - ) # JsonApiMemoryItemPostOptionalIdDocument | + ) # JsonApiReportTemplatePostOptionalIdDocument | 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) @@ -201,20 +174,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Post Memory Items - api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document) + # Post Report Template + api_response = api_instance.create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->create_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->create_entity_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post Memory Items - api_response = api_instance.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, include=include, meta_include=meta_include) + # Post Report Template + api_response = api_instance.create_entity_report_templates(workspace_id, json_api_report_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 AIApi->create_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->create_entity_report_templates: %s\n" % e) ``` @@ -223,13 +196,13 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | - **json_api_memory_item_post_optional_id_document** | [**JsonApiMemoryItemPostOptionalIdDocument**](JsonApiMemoryItemPostOptionalIdDocument.md)| | + **json_api_report_template_post_optional_id_document** | [**JsonApiReportTemplatePostOptionalIdDocument**](JsonApiReportTemplatePostOptionalIdDocument.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 -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -249,12 +222,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_entity_org_memory_items** -> JsonApiOrgMemoryItemOutDocument create_entity_org_memory_items(json_api_org_memory_item_in_document) - -Post organization Memory Item entities +# **create_entity_reports** +> JsonApiReportOutDocument create_entity_reports(workspace_id, json_api_report_post_optional_id_document) -Organization-scoped AI memory item +Post Report ### Example @@ -262,9 +233,9 @@ Organization-scoped AI memory item ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument 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. @@ -276,43 +247,49 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( - data=JsonApiOrgMemoryItemIn( - attributes=JsonApiOrgMemoryItemInAttributes( + api_instance = reports_api.ReportsApi(api_client) + workspace_id = "workspaceId_example" # str | + json_api_report_post_optional_id_document = JsonApiReportPostOptionalIdDocument( + data=JsonApiReportPostOptionalId( + attributes=JsonApiReportInAttributes( + are_relations_valid=True, + content={}, description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", ], - strategy="ALWAYS", title="title_example", + variable_values=None, ), id="id1", - type="orgMemoryItem", + type="report", ), - ) # JsonApiOrgMemoryItemInDocument | + ) # JsonApiReportPostOptionalIdDocument | 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 organization Memory Item entities - api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document) + # Post Report + api_response = api_instance.create_entity_reports(workspace_id, json_api_report_post_optional_id_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->create_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->create_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Post organization Memory Item entities - api_response = api_instance.create_entity_org_memory_items(json_api_org_memory_item_in_document, include=include) + # Post Report + api_response = api_instance.create_entity_reports(workspace_id, json_api_report_post_optional_id_document, include=include, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->create_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->create_entity_reports: %s\n" % e) ``` @@ -320,12 +297,14 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **workspace_id** | **str**| | + **json_api_report_post_optional_id_document** | [**JsonApiReportPostOptionalIdDocument**](JsonApiReportPostOptionalIdDocument.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 -[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization @@ -345,10 +324,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_knowledge_recommendations** -> delete_entity_knowledge_recommendations(workspace_id, object_id) +# **delete_entity_report_page_layouts** +> delete_entity_report_page_layouts(workspace_id, object_id) -Delete a Knowledge Recommendation +Delete a Report Page Layout ### Example @@ -356,7 +335,7 @@ Delete a Knowledge Recommendation ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api +from gooddata_api_client.api import reports_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. @@ -368,16 +347,16 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(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 Knowledge Recommendation - api_instance.delete_entity_knowledge_recommendations(workspace_id, object_id) + # Delete a Report Page Layout + api_instance.delete_entity_report_page_layouts(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->delete_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->delete_entity_report_page_layouts: %s\n" % e) ``` @@ -410,10 +389,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_memory_items** -> delete_entity_memory_items(workspace_id, object_id) +# **delete_entity_report_templates** +> delete_entity_report_templates(workspace_id, object_id) -Delete a Memory Item +Delete a Report Template ### Example @@ -421,7 +400,7 @@ Delete a Memory Item ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api +from gooddata_api_client.api import reports_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. @@ -433,16 +412,16 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(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 Memory Item - api_instance.delete_entity_memory_items(workspace_id, object_id) + # Delete a Report Template + api_instance.delete_entity_report_templates(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->delete_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->delete_entity_report_templates: %s\n" % e) ``` @@ -475,10 +454,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **delete_entity_org_memory_items** -> delete_entity_org_memory_items(id) +# **delete_entity_reports** +> delete_entity_reports(workspace_id, object_id) -Delete an organization Memory Item entity +Delete a Report ### Example @@ -486,7 +465,7 @@ Delete an organization Memory Item entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api +from gooddata_api_client.api import reports_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. @@ -498,15 +477,16 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | + api_instance = reports_api.ReportsApi(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 an organization Memory Item entity - api_instance.delete_entity_org_memory_items(id) + # Delete a Report + api_instance.delete_entity_reports(workspace_id, object_id) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->delete_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->delete_entity_reports: %s\n" % e) ``` @@ -514,7 +494,8 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | + **workspace_id** | **str**| | + **object_id** | **str**| | ### Return type @@ -538,10 +519,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_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutList get_all_entities_knowledge_recommendations(workspace_id) +# **get_all_entities_report_page_layouts** +> JsonApiReportPageLayoutOutList get_all_entities_report_page_layouts(workspace_id) -Get all Knowledge Recommendations +Get all Report Page Layouts ### Example @@ -549,8 +530,8 @@ Get all Knowledge Recommendations ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList 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. @@ -562,12 +543,12 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) 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 @@ -581,20 +562,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Knowledge Recommendations - api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id) + # Get all Report Page Layouts + api_response = api_instance.get_all_entities_report_page_layouts(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_all_entities_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->get_all_entities_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Knowledge Recommendations - api_response = api_instance.get_all_entities_knowledge_recommendations(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Report Page Layouts + api_response = api_instance.get_all_entities_report_page_layouts(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 AIApi->get_all_entities_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->get_all_entities_report_page_layouts: %s\n" % e) ``` @@ -614,7 +595,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) +[**JsonApiReportPageLayoutOutList**](JsonApiReportPageLayoutOutList.md) ### Authorization @@ -634,10 +615,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_memory_items** -> JsonApiMemoryItemOutList get_all_entities_memory_items(workspace_id) +# **get_all_entities_report_templates** +> JsonApiReportTemplateOutList get_all_entities_report_templates(workspace_id) -Get all Memory Items +Get all Report Templates ### Example @@ -645,8 +626,8 @@ Get all Memory Items ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList 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. @@ -658,7 +639,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;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) @@ -677,20 +658,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get all Memory Items - api_response = api_instance.get_all_entities_memory_items(workspace_id) + # Get all Report Templates + api_response = api_instance.get_all_entities_report_templates(workspace_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_all_entities_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_all_entities_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get all Memory Items - api_response = api_instance.get_all_entities_memory_items(workspace_id, origin=origin, filter=filter, include=include, page=page, size=size, sort=sort, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get all Report Templates + api_response = api_instance.get_all_entities_report_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 AIApi->get_all_entities_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_all_entities_report_templates: %s\n" % e) ``` @@ -710,7 +691,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) +[**JsonApiReportTemplateOutList**](JsonApiReportTemplateOutList.md) ### Authorization @@ -730,10 +711,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_org_memory_items** -> JsonApiOrgMemoryItemOutList get_all_entities_org_memory_items() +# **get_all_entities_reports** +> JsonApiReportOutList get_all_entities_reports(workspace_id) -Get all organization Memory Item entities +Get all Reports ### Example @@ -741,8 +722,8 @@ Get all organization Memory Item entities ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_out_list import JsonApiReportOutList 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. @@ -754,7 +735,9 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) + workspace_id = "workspaceId_example" # str | + origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;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", @@ -764,18 +747,27 @@ with gooddata_api_client.ApiClient() as api_client: 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 Reports + api_response = api_instance.get_all_entities_reports(workspace_id) + pprint(api_response) + except gooddata_api_client.ApiException as e: + print("Exception when calling ReportsApi->get_all_entities_reports: %s\n" % e) + # example passing only required values which don't have defaults set # and optional values try: - # Get all organization Memory Item entities - api_response = api_instance.get_all_entities_org_memory_items(filter=filter, include=include, page=page, size=size, sort=sort, meta_include=meta_include) + # Get all Reports + api_response = api_instance.get_all_entities_reports(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 AIApi->get_all_entities_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_all_entities_reports: %s\n" % e) ``` @@ -783,16 +775,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 -[**JsonApiOrgMemoryItemOutList**](JsonApiOrgMemoryItemOutList.md) +[**JsonApiReportOutList**](JsonApiReportOutList.md) ### Authorization @@ -812,10 +807,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument get_entity_knowledge_recommendations(workspace_id, object_id) +# **get_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument get_entity_report_page_layouts(workspace_id, object_id) -Get a Knowledge Recommendation +Get a Report Page Layout ### Example @@ -823,8 +818,8 @@ Get a Knowledge Recommendation ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument 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. @@ -836,12 +831,12 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ @@ -850,20 +845,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Knowledge Recommendation - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id) + # Get a Report Page Layout + api_response = api_instance.get_entity_report_page_layouts(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->get_entity_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Knowledge Recommendation - api_response = api_instance.get_entity_knowledge_recommendations(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Report Page Layout + api_response = api_instance.get_entity_report_page_layouts(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->get_entity_report_page_layouts: %s\n" % e) ``` @@ -880,7 +875,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -900,10 +895,10 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_entity_memory_items** -> JsonApiMemoryItemOutDocument get_entity_memory_items(workspace_id, object_id) +# **get_entity_report_templates** +> JsonApiReportTemplateOutDocument get_entity_report_templates(workspace_id, object_id) -Get a Memory Item +Get a Report Template ### Example @@ -911,8 +906,8 @@ Get a Memory Item ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -924,7 +919,7 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) @@ -938,20 +933,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get a Memory Item - api_response = api_instance.get_entity_memory_items(workspace_id, object_id) + # Get a Report Template + api_response = api_instance.get_entity_report_templates(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_entity_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get a Memory Item - api_response = api_instance.get_entity_memory_items(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) + # Get a Report Template + api_response = api_instance.get_entity_report_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 AIApi->get_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_entity_report_templates: %s\n" % e) ``` @@ -968,7 +963,7 @@ Name | Type | Description | Notes ### Return type -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -988,10 +983,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_org_memory_items** -> JsonApiOrgMemoryItemOutDocument get_entity_org_memory_items(id) +# **get_entity_reports** +> JsonApiReportOutDocument get_entity_reports(workspace_id, object_id) -Get an organization Memory Item entity +Get a Report ### Example @@ -999,8 +994,8 @@ Get an organization Memory Item entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument 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. @@ -1012,29 +1007,34 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | + api_instance = reports_api.ReportsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) + x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False + meta_include = [ + "metaInclude=origin,all", + ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set try: - # Get an organization Memory Item entity - api_response = api_instance.get_entity_org_memory_items(id) + # Get a Report + api_response = api_instance.get_entity_reports(workspace_id, object_id) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Get an organization Memory Item entity - api_response = api_instance.get_entity_org_memory_items(id, filter=filter, include=include) + # Get a Report + api_response = api_instance.get_entity_reports(workspace_id, object_id, filter=filter, include=include, x_gdc_validate_relations=x_gdc_validate_relations, meta_include=meta_include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->get_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->get_entity_reports: %s\n" % e) ``` @@ -1042,13 +1042,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 -[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization @@ -1068,10 +1071,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_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) +# **patch_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document) -Patch a Knowledge Recommendation +Patch a Report Page Layout ### Example @@ -1079,9 +1082,9 @@ Patch a Knowledge Recommendation ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument 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. @@ -1093,65 +1096,45 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_knowledge_recommendation_patch_document = JsonApiKnowledgeRecommendationPatchDocument( - data=JsonApiKnowledgeRecommendationPatch( - attributes=JsonApiKnowledgeRecommendationPatchAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, + json_api_report_page_layout_patch_document = JsonApiReportPageLayoutPatchDocument( + data=JsonApiReportPageLayoutPatch( + attributes=JsonApiReportPageLayoutPatchAttributes( are_relations_valid=True, - comparison_type="MONTH", - confidence=None, + content={}, description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, tags=[ "tags_example", ], title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", ), id="id1", - relationships=JsonApiKnowledgeRecommendationOutRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", + type="reportPageLayout", ), - ) # JsonApiKnowledgeRecommendationPatchDocument | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiReportPageLayoutPatchDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Patch a Knowledge Recommendation - api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document) + # Patch a Report Page Layout + api_response = api_instance.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->patch_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->patch_entity_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Knowledge Recommendation - api_response = api_instance.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, filter=filter, include=include) + # Patch a Report Page Layout + api_response = api_instance.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->patch_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->patch_entity_report_page_layouts: %s\n" % e) ``` @@ -1161,13 +1144,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_knowledge_recommendation_patch_document** | [**JsonApiKnowledgeRecommendationPatchDocument**](JsonApiKnowledgeRecommendationPatchDocument.md)| | + **json_api_report_page_layout_patch_document** | [**JsonApiReportPageLayoutPatchDocument**](JsonApiReportPageLayoutPatchDocument.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 -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -1187,10 +1170,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_memory_items** -> JsonApiMemoryItemOutDocument patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) +# **patch_entity_report_templates** +> JsonApiReportTemplateOutDocument patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document) -Patch a Memory Item +Patch a Report Template ### Example @@ -1198,9 +1181,9 @@ Patch a Memory Item ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -1212,29 +1195,24 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_memory_item_patch_document = JsonApiMemoryItemPatchDocument( - data=JsonApiMemoryItemPatch( - attributes=JsonApiMemoryItemPatchAttributes( + json_api_report_template_patch_document = JsonApiReportTemplatePatchDocument( + data=JsonApiReportTemplatePatch( + attributes=JsonApiReportTemplatePatchAttributes( are_relations_valid=True, + content={}, description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", - ], - strategy="ALWAYS", tags=[ "tags_example", ], title="title_example", ), id="id1", - type="memoryItem", + type="reportTemplate", ), - ) # JsonApiMemoryItemPatchDocument | + ) # JsonApiReportTemplatePatchDocument | 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", @@ -1242,20 +1220,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch a Memory Item - api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document) + # Patch a Report Template + api_response = api_instance.patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->patch_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->patch_entity_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch a Memory Item - api_response = api_instance.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, filter=filter, include=include) + # Patch a Report Template + api_response = api_instance.patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->patch_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->patch_entity_report_templates: %s\n" % e) ``` @@ -1265,13 +1243,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_memory_item_patch_document** | [**JsonApiMemoryItemPatchDocument**](JsonApiMemoryItemPatchDocument.md)| | + **json_api_report_template_patch_document** | [**JsonApiReportTemplatePatchDocument**](JsonApiReportTemplatePatchDocument.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 -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -1291,10 +1269,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_org_memory_items** -> JsonApiOrgMemoryItemOutDocument patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) +# **patch_entity_reports** +> JsonApiReportOutDocument patch_entity_reports(workspace_id, object_id, json_api_report_patch_document) -Patch an organization Memory Item entity +Patch a Report ### Example @@ -1302,9 +1280,9 @@ Patch an organization Memory Item entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument 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. @@ -1316,24 +1294,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_org_memory_item_patch_document = JsonApiOrgMemoryItemPatchDocument( - data=JsonApiOrgMemoryItemPatch( - attributes=JsonApiOrgMemoryItemPatchAttributes( + api_instance = reports_api.ReportsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_patch_document = JsonApiReportPatchDocument( + data=JsonApiReportPatch( + attributes=JsonApiReportPatchAttributes( + are_relations_valid=True, + content={}, description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", ], - strategy="ALWAYS", title="title_example", + variable_values=None, ), id="id1", - type="orgMemoryItem", + type="report", ), - ) # JsonApiOrgMemoryItemPatchDocument | + ) # JsonApiReportPatchDocument | 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", @@ -1341,20 +1322,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Patch an organization Memory Item entity - api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document) + # Patch a Report + api_response = api_instance.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->patch_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->patch_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Patch an organization Memory Item entity - api_response = api_instance.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, filter=filter, include=include) + # Patch a Report + api_response = api_instance.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->patch_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->patch_entity_reports: %s\n" % e) ``` @@ -1362,14 +1343,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_org_memory_item_patch_document** | [**JsonApiOrgMemoryItemPatchDocument**](JsonApiOrgMemoryItemPatchDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_patch_document** | [**JsonApiReportPatchDocument**](JsonApiReportPatchDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization @@ -1389,10 +1371,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) -# **search_entities_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutList search_entities_knowledge_recommendations(workspace_id, entity_search_body) +# **update_entity_report_page_layouts** +> JsonApiReportPageLayoutOutDocument update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document) -The search endpoint (beta) +Put a Report Page Layout ### Example @@ -1400,9 +1382,9 @@ The search endpoint (beta) ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_in_document import JsonApiReportPageLayoutInDocument 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. @@ -1414,263 +1396,45 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # The search endpoint (beta) - api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->search_entities_knowledge_recommendations: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # The search endpoint (beta) - api_response = api_instance.search_entities_knowledge_recommendations(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->search_entities_knowledge_recommendations: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiKnowledgeRecommendationOutList**](JsonApiKnowledgeRecommendationOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Request successfully processed | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **search_entities_memory_items** -> JsonApiMemoryItemOutList search_entities_memory_items(workspace_id, entity_search_body) - -The search endpoint (beta) - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList -from gooddata_api_client.model.entity_search_body import EntitySearchBody -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - workspace_id = "workspaceId_example" # str | - entity_search_body = EntitySearchBody( - filter="filter_example", - include=[ - "include_example", - ], - meta_include=[ - "meta_include_example", - ], - page=EntitySearchPage( - index=0, - size=100, - ), - sort=[ - EntitySearchSort( - direction="ASC", - _property="_property_example", - ), - ], - ) # EntitySearchBody | Search request body with filter, pagination, and sorting options - origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" - x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False - - # example passing only required values which don't have defaults set - try: - # The search endpoint (beta) - api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->search_entities_memory_items: %s\n" % e) - - # example passing only required values which don't have defaults set - # and optional values - try: - # The search endpoint (beta) - api_response = api_instance.search_entities_memory_items(workspace_id, entity_search_body, origin=origin, x_gdc_validate_relations=x_gdc_validate_relations) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->search_entities_memory_items: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| | - **entity_search_body** | [**EntitySearchBody**](EntitySearchBody.md)| Search request body with filter, pagination, and sorting options | - **origin** | **str**| | [optional] if omitted the server will use the default value of "ALL" - **x_gdc_validate_relations** | **bool**| | [optional] if omitted the server will use the default value of False - -### Return type - -[**JsonApiMemoryItemOutList**](JsonApiMemoryItemOutList.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json, application/vnd.gooddata.api+json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**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_knowledge_recommendations** -> JsonApiKnowledgeRecommendationOutDocument update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) - -Put a Knowledge Recommendation - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument -from pprint import pprint -# Defining the host is optional and defaults to http://localhost -# See configuration.py for a list of all supported configuration parameters. -configuration = gooddata_api_client.Configuration( - host = "http://localhost" -) - - -# Enter a context with an instance of the API client -with gooddata_api_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_knowledge_recommendation_in_document = JsonApiKnowledgeRecommendationInDocument( - data=JsonApiKnowledgeRecommendationIn( - attributes=JsonApiKnowledgeRecommendationInAttributes( - analytical_dashboard_title="Portfolio Health Insights", - analyzed_period="2023-07", - analyzed_value=None, + json_api_report_page_layout_in_document = JsonApiReportPageLayoutInDocument( + data=JsonApiReportPageLayoutIn( + attributes=JsonApiReportPageLayoutInAttributes( are_relations_valid=True, - comparison_type="MONTH", - confidence=None, + content={}, description="description_example", - direction="DECREASED", - metric_title="Revenue", - recommendations={}, - reference_period="2023-06", - reference_value=None, - source_count=2, tags=[ "tags_example", ], title="title_example", - widget_id="widget-123", - widget_name="Revenue Trend", ), id="id1", - relationships=JsonApiKnowledgeRecommendationInRelationships( - analytical_dashboard=JsonApiAutomationInRelationshipsAnalyticalDashboard( - data=JsonApiAnalyticalDashboardToOneLinkage(None), - ), - metric=JsonApiKnowledgeRecommendationInRelationshipsMetric( - data=JsonApiMetricToOneLinkage(None), - ), - ), - type="knowledgeRecommendation", + type="reportPageLayout", ), - ) # JsonApiKnowledgeRecommendationInDocument | - filter = "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) + ) # JsonApiReportPageLayoutInDocument | + filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "metric,analyticalDashboard", + "createdBy,modifiedBy", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set try: - # Put a Knowledge Recommendation - api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document) + # Put a Report Page Layout + api_response = api_instance.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->update_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->update_entity_report_page_layouts: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Knowledge Recommendation - api_response = api_instance.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, filter=filter, include=include) + # Put a Report Page Layout + api_response = api_instance.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->update_entity_knowledge_recommendations: %s\n" % e) + print("Exception when calling ReportsApi->update_entity_report_page_layouts: %s\n" % e) ``` @@ -1680,13 +1444,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_knowledge_recommendation_in_document** | [**JsonApiKnowledgeRecommendationInDocument**](JsonApiKnowledgeRecommendationInDocument.md)| | + **json_api_report_page_layout_in_document** | [**JsonApiReportPageLayoutInDocument**](JsonApiReportPageLayoutInDocument.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 -[**JsonApiKnowledgeRecommendationOutDocument**](JsonApiKnowledgeRecommendationOutDocument.md) +[**JsonApiReportPageLayoutOutDocument**](JsonApiReportPageLayoutOutDocument.md) ### Authorization @@ -1706,10 +1470,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_memory_items** -> JsonApiMemoryItemOutDocument update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) +# **update_entity_report_templates** +> JsonApiReportTemplateOutDocument update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document) -Put a Memory Item +Put a Report Template ### Example @@ -1717,9 +1481,9 @@ Put a Memory Item ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument 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. @@ -1731,29 +1495,24 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) + api_instance = reports_api.ReportsApi(api_client) workspace_id = "workspaceId_example" # str | object_id = "objectId_example" # str | - json_api_memory_item_in_document = JsonApiMemoryItemInDocument( - data=JsonApiMemoryItemIn( - attributes=JsonApiMemoryItemInAttributes( + json_api_report_template_in_document = JsonApiReportTemplateInDocument( + data=JsonApiReportTemplateIn( + attributes=JsonApiReportTemplateInAttributes( are_relations_valid=True, + content={}, description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", - ], - strategy="ALWAYS", tags=[ "tags_example", ], title="title_example", ), id="id1", - type="memoryItem", + type="reportTemplate", ), - ) # JsonApiMemoryItemInDocument | + ) # JsonApiReportTemplateInDocument | 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", @@ -1761,20 +1520,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Put a Memory Item - api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document) + # Put a Report Template + api_response = api_instance.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->update_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->update_entity_report_templates: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put a Memory Item - api_response = api_instance.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, filter=filter, include=include) + # Put a Report Template + api_response = api_instance.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->update_entity_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->update_entity_report_templates: %s\n" % e) ``` @@ -1784,13 +1543,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| | **object_id** | **str**| | - **json_api_memory_item_in_document** | [**JsonApiMemoryItemInDocument**](JsonApiMemoryItemInDocument.md)| | + **json_api_report_template_in_document** | [**JsonApiReportTemplateInDocument**](JsonApiReportTemplateInDocument.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 -[**JsonApiMemoryItemOutDocument**](JsonApiMemoryItemOutDocument.md) +[**JsonApiReportTemplateOutDocument**](JsonApiReportTemplateOutDocument.md) ### Authorization @@ -1810,10 +1569,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_org_memory_items** -> JsonApiOrgMemoryItemOutDocument update_entity_org_memory_items(id, json_api_org_memory_item_in_document) +# **update_entity_reports** +> JsonApiReportOutDocument update_entity_reports(workspace_id, object_id, json_api_report_in_document) -Put an organization Memory Item entity +Put a Report ### Example @@ -1821,9 +1580,9 @@ Put an organization Memory Item entity ```python import time import gooddata_api_client -from gooddata_api_client.api import ai_api -from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.api import reports_api +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_in_document import JsonApiReportInDocument 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. @@ -1835,24 +1594,27 @@ configuration = gooddata_api_client.Configuration( # Enter a context with an instance of the API client with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class - api_instance = ai_api.AIApi(api_client) - id = "/6bUUGjjNSwg0_bs" # str | - json_api_org_memory_item_in_document = JsonApiOrgMemoryItemInDocument( - data=JsonApiOrgMemoryItemIn( - attributes=JsonApiOrgMemoryItemInAttributes( + api_instance = reports_api.ReportsApi(api_client) + workspace_id = "workspaceId_example" # str | + object_id = "objectId_example" # str | + json_api_report_in_document = JsonApiReportInDocument( + data=JsonApiReportIn( + attributes=JsonApiReportInAttributes( + are_relations_valid=True, + content={}, description="description_example", - instruction="instruction_example", - is_disabled=True, - keywords=[ - "keywords_example", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "tags_example", ], - strategy="ALWAYS", title="title_example", + variable_values=None, ), id="id1", - type="orgMemoryItem", + type="report", ), - ) # JsonApiOrgMemoryItemInDocument | + ) # JsonApiReportInDocument | 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", @@ -1860,20 +1622,20 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Put an organization Memory Item entity - api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document) + # Put a Report + api_response = api_instance.update_entity_reports(workspace_id, object_id, json_api_report_in_document) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->update_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->update_entity_reports: %s\n" % e) # example passing only required values which don't have defaults set # and optional values try: - # Put an organization Memory Item entity - api_response = api_instance.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, filter=filter, include=include) + # Put a Report + api_response = api_instance.update_entity_reports(workspace_id, object_id, json_api_report_in_document, filter=filter, include=include) pprint(api_response) except gooddata_api_client.ApiException as e: - print("Exception when calling AIApi->update_entity_org_memory_items: %s\n" % e) + print("Exception when calling ReportsApi->update_entity_reports: %s\n" % e) ``` @@ -1881,14 +1643,15 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **str**| | - **json_api_org_memory_item_in_document** | [**JsonApiOrgMemoryItemInDocument**](JsonApiOrgMemoryItemInDocument.md)| | + **workspace_id** | **str**| | + **object_id** | **str**| | + **json_api_report_in_document** | [**JsonApiReportInDocument**](JsonApiReportInDocument.md)| | **filter** | **str**| Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). | [optional] **include** | **[str]**| Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. | [optional] ### Return type -[**JsonApiOrgMemoryItemOutDocument**](JsonApiOrgMemoryItemOutDocument.md) +[**JsonApiReportOutDocument**](JsonApiReportOutDocument.md) ### Authorization diff --git a/gooddata-api-client/docs/ResolvedLlmProvider.md b/gooddata-api-client/docs/ResolvedLlmProvider.md deleted file mode 100644 index 126ed8e96..000000000 --- a/gooddata-api-client/docs/ResolvedLlmProvider.md +++ /dev/null @@ -1,14 +0,0 @@ -# ResolvedLlmProvider - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Provider Id | -**title** | **str** | Provider Title | -**models** | [**[LlmModel]**](LlmModel.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/ResolvedLlmProviderAllOf.md b/gooddata-api-client/docs/ResolvedLlmProviderAllOf.md deleted file mode 100644 index 44cbec2b6..000000000 --- a/gooddata-api-client/docs/ResolvedLlmProviderAllOf.md +++ /dev/null @@ -1,14 +0,0 @@ -# ResolvedLlmProviderAllOf - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Provider Id | [optional] -**models** | [**[LlmModel]**](LlmModel.md) | | [optional] -**title** | **str** | Provider Title | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/ResolvedLlms.md b/gooddata-api-client/docs/ResolvedLlms.md deleted file mode 100644 index bcf8045f8..000000000 --- a/gooddata-api-client/docs/ResolvedLlms.md +++ /dev/null @@ -1,12 +0,0 @@ -# ResolvedLlms - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | [**ResolvedLlmsData**](ResolvedLlmsData.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/ResolvedLlmsData.md b/gooddata-api-client/docs/ResolvedLlmsData.md deleted file mode 100644 index 9da83f0e9..000000000 --- a/gooddata-api-client/docs/ResolvedLlmsData.md +++ /dev/null @@ -1,14 +0,0 @@ -# ResolvedLlmsData - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Provider Id | [optional] -**title** | **str** | Provider Title | [optional] -**models** | [**[LlmModel]**](LlmModel.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/RestrictedObject.md b/gooddata-api-client/docs/RestrictedObject.md new file mode 100644 index 000000000..c6ee341dd --- /dev/null +++ b/gooddata-api-client/docs/RestrictedObject.md @@ -0,0 +1,14 @@ +# RestrictedObject + +A reference the caller may not view. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Object identifier, unique within one workspace hierarchy. | +**type** | **str** | JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`. | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/RichTextWidgetDescriptor.md b/gooddata-api-client/docs/RichTextWidgetDescriptor.md deleted file mode 100644 index aa6a1b4aa..000000000 --- a/gooddata-api-client/docs/RichTextWidgetDescriptor.md +++ /dev/null @@ -1,17 +0,0 @@ -# RichTextWidgetDescriptor - -Rich text widget displaying static content. Has no execution result. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**title** | **str** | Widget title as displayed on the dashboard. | -**widget_id** | **str** | Widget object ID. | -**widget_type** | **str** | | defaults to "richText" -**content** | **str** | Markdown/text content of the rich text widget. | [optional] -**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Filters currently applied to the dashboard. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/RouteResult.md b/gooddata-api-client/docs/RouteResult.md deleted file mode 100644 index 488c7e549..000000000 --- a/gooddata-api-client/docs/RouteResult.md +++ /dev/null @@ -1,14 +0,0 @@ -# RouteResult - -Question -> Use Case routing. May contain final answer is a special use case is not required. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reasoning** | **str** | Explanation why LLM picked this use case. | -**use_case** | **str** | Use case where LLM routed based on question. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/SearchRelationshipObject.md b/gooddata-api-client/docs/SearchRelationshipObject.md deleted file mode 100644 index a153fb111..000000000 --- a/gooddata-api-client/docs/SearchRelationshipObject.md +++ /dev/null @@ -1,19 +0,0 @@ -# SearchRelationshipObject - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**source_object_id** | **str** | Source object ID. | -**source_object_title** | **str** | Source object title. | -**source_object_type** | **str** | Source object type, e.g. dashboard. | -**source_workspace_id** | **str** | Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located. | -**target_object_id** | **str** | Target object ID. | -**target_object_title** | **str** | Target object title. | -**target_object_type** | **str** | Target object type, e.g. visualization. | -**target_workspace_id** | **str** | Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/SearchRequest.md b/gooddata-api-client/docs/SearchRequest.md deleted file mode 100644 index f4ebbe5fc..000000000 --- a/gooddata-api-client/docs/SearchRequest.md +++ /dev/null @@ -1,22 +0,0 @@ -# SearchRequest - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**question** | **str** | Keyword/sentence is input for search. | -**allowed_relationship_types** | [**[AllowedRelationshipType]**](AllowedRelationshipType.md) | Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out. | [optional] -**deep_search** | **bool** | Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations. | [optional] if omitted the server will use the default value of False -**enable_hybrid_search** | **bool** | If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches. | [optional] if omitted the server will use the default value of False -**exclude_tags** | **[str]** | Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results. | [optional] -**include_hidden** | **bool** | If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true. | [optional] if omitted the server will use the default value of False -**include_tags** | **[str]** | Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter. | [optional] -**limit** | **int** | Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search. | [optional] if omitted the server will use the default value of 10 -**object_types** | **[str]** | List of object types to search for. | [optional] -**relevant_score_threshold** | **float** | Score, above which we return found objects. Below this score objects are not relevant. | [optional] if omitted the server will use the default value of 0.3 -**title_to_descriptor_ratio** | **float** | Temporary for experiments. Ratio of title score to descriptor score. | [optional] if omitted the server will use the default value of 0.7 -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/SearchResult.md b/gooddata-api-client/docs/SearchResult.md deleted file mode 100644 index 66fd4be08..000000000 --- a/gooddata-api-client/docs/SearchResult.md +++ /dev/null @@ -1,15 +0,0 @@ -# SearchResult - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reasoning** | **str** | DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation. | -**relationships** | [**[SearchRelationshipObject]**](SearchRelationshipObject.md) | | -**results** | [**[SearchResultObject]**](SearchResultObject.md) | | -**error** | [**ErrorInfo**](ErrorInfo.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/SearchResultObject.md b/gooddata-api-client/docs/SearchResultObject.md deleted file mode 100644 index cb580d3c2..000000000 --- a/gooddata-api-client/docs/SearchResultObject.md +++ /dev/null @@ -1,26 +0,0 @@ -# SearchResultObject - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | Object ID. | -**title** | **str** | Object title. | -**type** | **str** | Object type, e.g. dashboard. | -**workspace_id** | **str** | Workspace ID. | -**certification** | [**CertificationInfo**](CertificationInfo.md) | | [optional] -**created_at** | **datetime** | Timestamp when object was created. | [optional] -**description** | **str** | Object description. | [optional] -**is_hidden** | **bool** | If true, this object is hidden from AI search results by default. | [optional] -**modified_at** | **datetime** | Timestamp when object was last modified. | [optional] -**score** | **float** | Result score calculated by a similarity search algorithm (cosine_distance). | [optional] -**score_descriptor** | **float** | Result score for descriptor containing(now) description and tags. | [optional] -**score_exact_match** | **int** | Result score for exact match(id/title). 1/1000. Other scores are multiplied by this. | [optional] -**score_title** | **float** | Result score for object title. | [optional] -**tags** | **[str]** | | [optional] -**visualization_url** | **str** | If the object is visualization, this field defines the type of visualization. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/SmartFunctionsApi.md b/gooddata-api-client/docs/SmartFunctionsApi.md index 326c027cf..913b6b347 100644 --- a/gooddata-api-client/docs/SmartFunctionsApi.md +++ b/gooddata-api-client/docs/SmartFunctionsApi.md @@ -4,11 +4,10 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- -[**ai_chat**](SmartFunctionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (BETA) Chat with AI -[**ai_chat_history**](SmartFunctionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (BETA) Get Chat History -[**ai_chat_stream**](SmartFunctionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (BETA) Chat with AI -[**ai_chat_usage**](SmartFunctionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | Get Chat Usage -[**ai_search**](SmartFunctionsApi.md#ai_search) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/search | (BETA) Semantic Search in Metadata +[**ai_chat**](SmartFunctionsApi.md#ai_chat) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chat | (REMOVED) Chat with AI +[**ai_chat_history**](SmartFunctionsApi.md#ai_chat_history) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatHistory | (REMOVED) Get Chat History +[**ai_chat_stream**](SmartFunctionsApi.md#ai_chat_stream) | **POST** /api/v1/actions/workspaces/{workspaceId}/ai/chatStream | (REMOVED) Chat with AI +[**ai_chat_usage**](SmartFunctionsApi.md#ai_chat_usage) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/chatUsage | (REMOVED) Get Chat Usage [**anomaly_detection**](SmartFunctionsApi.md#anomaly_detection) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection [**anomaly_detection_result**](SmartFunctionsApi.md#anomaly_detection_result) | **GET** /api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId} | (EXPERIMENTAL) Smart functions - Anomaly Detection Result [**clustering**](SmartFunctionsApi.md#clustering) | **POST** /api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId} | (EXPERIMENTAL) Smart functions - Clustering @@ -24,7 +23,6 @@ Method | HTTP request | Description [**list_llm_provider_models_by_id**](SmartFunctionsApi.md#list_llm_provider_models_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/listModels | List LLM Provider Models By Id [**memory_created_by_users**](SmartFunctionsApi.md#memory_created_by_users) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy | Get AI Memory CreatedBy Users [**resolve_llm_endpoints**](SmartFunctionsApi.md#resolve_llm_endpoints) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints | Get Active LLM Endpoints for this workspace (Removed) -[**resolve_llm_providers**](SmartFunctionsApi.md#resolve_llm_providers) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders | Get Active LLM configuration for this workspace [**tags**](SmartFunctionsApi.md#tags) | **GET** /api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags | Get Analytics Catalog Tags [**test_llm_provider**](SmartFunctionsApi.md#test_llm_provider) | **POST** /api/v1/actions/ai/llmProvider/test | Test LLM Provider [**test_llm_provider_by_id**](SmartFunctionsApi.md#test_llm_provider_by_id) | **POST** /api/v1/actions/ai/llmProvider/{llmProviderId}/test | Test LLM Provider By Id @@ -35,11 +33,11 @@ Method | HTTP request | Description # **ai_chat** -> ChatResult ai_chat(workspace_id, chat_request) +> ai_chat(workspace_id) -(BETA) Chat with AI +(REMOVED) Chat with AI -(BETA) Combines multiple use cases such as search, create visualizations, ... +Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. ### Example @@ -48,8 +46,6 @@ Method | HTTP request | Description import time import gooddata_api_client from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_request import ChatRequest 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. @@ -63,69 +59,11 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_request = ChatRequest( - allowed_relationship_types=[ - AllowedRelationshipType( - allow_orphans=True, - source_type="attribute", - target_type="attribute", - ), - ], - include_hidden=False, - limit_create=3, - limit_create_context=10, - limit_search=5, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - referenced_objects=[ - ObjectReferenceGroup( - context=ObjectReference( - id="id_example", - type="WIDGET", - ), - objects=[ - ObjectReference( - id="id_example", - type="WIDGET", - ), - ], - ), - ], - view=UIContext( - dashboard=DashboardContext( - id="id_example", - widgets=[ - WidgetDescriptor( - filters=[ - FilterDefinition(), - ], - title="title_example", - widget_id="widget_id_example", - widget_type="widget_type_example", - ), - ], - ), - ), - ), - ) # ChatRequest | # example passing only required values which don't have defaults set try: - # (BETA) Chat with AI - api_response = api_instance.ai_chat(workspace_id, chat_request) - pprint(api_response) + # (REMOVED) Chat with AI + api_instance.ai_chat(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling SmartFunctionsApi->ai_chat: %s\n" % e) ``` @@ -136,11 +74,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type -[**ChatResult**](ChatResult.md) +void (empty response body) ### Authorization @@ -148,24 +85,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_history** -> ChatHistoryResult ai_chat_history(workspace_id, chat_history_request) +> ai_chat_history(workspace_id) -(BETA) Get Chat History +(REMOVED) Get Chat History -(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. +Removed. Chat history is served by the AI Assistant API. ### Example @@ -174,8 +111,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest 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. @@ -189,24 +124,11 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_history_request = ChatHistoryRequest( - chat_history_interaction_id="chat_history_interaction_id_example", - reset=True, - response_state="SUCCESSFUL", - saved_visualization=SavedVisualization( - created_visualization_id="created_visualization_id_example", - saved_visualization_id="saved_visualization_id_example", - ), - thread_id_suffix="thread_id_suffix_example", - user_feedback="POSITIVE", - user_text_feedback="user_text_feedback_example", - ) # ChatHistoryRequest | # example passing only required values which don't have defaults set try: - # (BETA) Get Chat History - api_response = api_instance.ai_chat_history(workspace_id, chat_history_request) - pprint(api_response) + # (REMOVED) Get Chat History + api_instance.ai_chat_history(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling SmartFunctionsApi->ai_chat_history: %s\n" % e) ``` @@ -217,11 +139,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **chat_history_request** | [**ChatHistoryRequest**](ChatHistoryRequest.md)| | ### Return type -[**ChatHistoryResult**](ChatHistoryResult.md) +void (empty response body) ### Authorization @@ -229,24 +150,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_stream** -> [dict] ai_chat_stream(workspace_id, chat_request) +> ai_chat_stream(workspace_id) -(BETA) Chat with AI +(REMOVED) Chat with AI -(BETA) Combines multiple use cases such as search, create visualizations, ... +Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. ### Example @@ -255,7 +176,6 @@ No authorization required import time import gooddata_api_client from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_request import ChatRequest 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. @@ -269,69 +189,11 @@ with gooddata_api_client.ApiClient() as api_client: # Create an instance of the API class api_instance = smart_functions_api.SmartFunctionsApi(api_client) workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - chat_request = ChatRequest( - allowed_relationship_types=[ - AllowedRelationshipType( - allow_orphans=True, - source_type="attribute", - target_type="attribute", - ), - ], - include_hidden=False, - limit_create=3, - limit_create_context=10, - limit_search=5, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.45, - search_score_threshold=0.9, - thread_id_suffix="thread_id_suffix_example", - title_to_descriptor_ratio=0.7, - user_context=UserContext( - active_object=ActiveObjectIdentification( - id="id_example", - type="type_example", - workspace_id="workspace_id_example", - ), - referenced_objects=[ - ObjectReferenceGroup( - context=ObjectReference( - id="id_example", - type="WIDGET", - ), - objects=[ - ObjectReference( - id="id_example", - type="WIDGET", - ), - ], - ), - ], - view=UIContext( - dashboard=DashboardContext( - id="id_example", - widgets=[ - WidgetDescriptor( - filters=[ - FilterDefinition(), - ], - title="title_example", - widget_id="widget_id_example", - widget_type="widget_type_example", - ), - ], - ), - ), - ), - ) # ChatRequest | # example passing only required values which don't have defaults set try: - # (BETA) Chat with AI - api_response = api_instance.ai_chat_stream(workspace_id, chat_request) - pprint(api_response) + # (REMOVED) Chat with AI + api_instance.ai_chat_stream(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling SmartFunctionsApi->ai_chat_stream: %s\n" % e) ``` @@ -342,11 +204,10 @@ with gooddata_api_client.ApiClient() as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **workspace_id** | **str**| Workspace identifier | - **chat_request** | [**ChatRequest**](ChatRequest.md)| | ### Return type -**[dict]** +void (empty response body) ### Authorization @@ -354,24 +215,24 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: text/event-stream + - **Content-Type**: Not defined + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **ai_chat_usage** -> ChatUsageResponse ai_chat_usage(workspace_id) +> ai_chat_usage(workspace_id) -Get Chat Usage +(REMOVED) Get Chat Usage -Returns usage statistics of chat for a user in a workspace. +Removed. Chat usage is served by the AI Assistant API. ### Example @@ -380,7 +241,6 @@ Returns usage statistics of chat for a user in a workspace. import time import gooddata_api_client from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse from pprint import pprint # Defining the host is optional and defaults to http://localhost # See configuration.py for a list of all supported configuration parameters. @@ -397,9 +257,8 @@ with gooddata_api_client.ApiClient() as api_client: # example passing only required values which don't have defaults set try: - # Get Chat Usage - api_response = api_instance.ai_chat_usage(workspace_id) - pprint(api_response) + # (REMOVED) Get Chat Usage + api_instance.ai_chat_usage(workspace_id) except gooddata_api_client.ApiException as e: print("Exception when calling SmartFunctionsApi->ai_chat_usage: %s\n" % e) ``` @@ -413,7 +272,7 @@ Name | Type | Description | Notes ### Return type -[**ChatUsageResponse**](ChatUsageResponse.md) +void (empty response body) ### Authorization @@ -422,108 +281,14 @@ 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) - -# **ai_search** -> SearchResult ai_search(workspace_id, search_request) - -(BETA) Semantic Search in Metadata - -(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.search_request import SearchRequest -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 = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - search_request = SearchRequest( - allowed_relationship_types=[ - AllowedRelationshipType( - allow_orphans=True, - source_type="attribute", - target_type="attribute", - ), - ], - deep_search=False, - enable_hybrid_search=False, - exclude_tags=[ - "exclude_tags_example", - ], - include_hidden=False, - include_tags=[ - "include_tags_example", - ], - limit=10, - object_types=[ - "attribute", - ], - question="question_example", - relevant_score_threshold=0.3, - title_to_descriptor_ratio=0.7, - ) # SearchRequest | - - # example passing only required values which don't have defaults set - try: - # (BETA) Semantic Search in Metadata - api_response = api_instance.ai_search(workspace_id, search_request) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->ai_search: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - **search_request** | [**SearchRequest**](SearchRequest.md)| | - -### Return type - -[**SearchResult**](SearchResult.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json + - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | +**410** | Gone | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1649,73 +1414,6 @@ 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) -# **resolve_llm_providers** -> ResolvedLlms resolve_llm_providers(workspace_id) - -Get Active LLM configuration for this workspace - -Resolves the active LLM provider configuration for the given workspace. - -### Example - - -```python -import time -import gooddata_api_client -from gooddata_api_client.api import smart_functions_api -from gooddata_api_client.model.resolved_llms import ResolvedLlms -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 = smart_functions_api.SmartFunctionsApi(api_client) - workspace_id = "/6bUUGjjNSwg0_bs" # str | Workspace identifier - - # example passing only required values which don't have defaults set - try: - # Get Active LLM configuration for this workspace - api_response = api_instance.resolve_llm_providers(workspace_id) - pprint(api_response) - except gooddata_api_client.ApiException as e: - print("Exception when calling SmartFunctionsApi->resolve_llm_providers: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **workspace_id** | **str**| Workspace identifier | - -### Return type - -[**ResolvedLlms**](ResolvedLlms.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) - # **tags** > AnalyticsCatalogTags tags(workspace_id) diff --git a/gooddata-api-client/docs/SqlFlowInput.md b/gooddata-api-client/docs/SqlFlowInput.md new file mode 100644 index 000000000..1739da998 --- /dev/null +++ b/gooddata-api-client/docs/SqlFlowInput.md @@ -0,0 +1,15 @@ +# SqlFlowInput + +Runs a SELECT statement on a data source and reads its rows as a table. Its columns are named and typed as the statement returns them. Data filters of the workspace and of the user do not apply. A GDSTORAGE, FlexConnect or platform-managed data source cannot run it. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_id** | **str** | Identifier of the data source that runs the statement. | +**sql** | **str** | One SELECT statement in the SQL dialect of the data source. | +**type** | **str** | Type of the input. | defaults to "sql" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/SqlFlowInputAllOf.md b/gooddata-api-client/docs/SqlFlowInputAllOf.md new file mode 100644 index 000000000..d525220e6 --- /dev/null +++ b/gooddata-api-client/docs/SqlFlowInputAllOf.md @@ -0,0 +1,14 @@ +# SqlFlowInputAllOf + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data_source_id** | **str** | Identifier of the data source that runs the statement. | [optional] +**sql** | **str** | One SELECT statement in the SQL dialect of the data source. | [optional] +**type** | **str** | Type of the input. | [optional] if omitted the server will use the default value of "sql" +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/SucceededOperation.md b/gooddata-api-client/docs/SucceededOperation.md index 8b88eb844..18cbcfa68 100644 --- a/gooddata-api-client/docs/SucceededOperation.md +++ b/gooddata-api-client/docs/SucceededOperation.md @@ -6,7 +6,7 @@ Operation that has succeeded Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Id of the operation | -**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). | +**kind** | **str** | Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. | **status** | **str** | | defaults to "succeeded" **result** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Operation-specific result payload, can be missing for operations like delete | [optional] **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] diff --git a/gooddata-api-client/docs/Suggestion.md b/gooddata-api-client/docs/Suggestion.md deleted file mode 100644 index 2465bb44c..000000000 --- a/gooddata-api-client/docs/Suggestion.md +++ /dev/null @@ -1,14 +0,0 @@ -# Suggestion - -List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**label** | **str** | Suggestion button label | -**query** | **str** | Suggestion query | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/TabularExportApi.md b/gooddata-api-client/docs/TabularExportApi.md index f26b26c49..8771cbe7b 100644 --- a/gooddata-api-client/docs/TabularExportApi.md +++ b/gooddata-api-client/docs/TabularExportApi.md @@ -144,6 +144,27 @@ with gooddata_api_client.ApiClient() as api_client: api_instance = tabular_export_api.TabularExportApi(api_client) workspace_id = "workspaceId_example" # str | tabular_export_request = TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( diff --git a/gooddata-api-client/docs/TabularExportRequest.md b/gooddata-api-client/docs/TabularExportRequest.md index e3a3c6e8f..b42303e89 100644 --- a/gooddata-api-client/docs/TabularExportRequest.md +++ b/gooddata-api-client/docs/TabularExportRequest.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file_name** | **str** | Filename of downloaded file without extension. | **format** | **str** | Expected file format. | +**conditional_formatting** | [**ConditionalFormatting**](ConditionalFormatting.md) | | [optional] **custom_override** | [**CustomOverride**](CustomOverride.md) | | [optional] **execution_result** | **str** | Execution result identifier. | [optional] **execution_settings** | [**ExecutionSettings**](ExecutionSettings.md) | | [optional] diff --git a/gooddata-api-client/docs/Thought.md b/gooddata-api-client/docs/Thought.md deleted file mode 100644 index eccfe8f66..000000000 --- a/gooddata-api-client/docs/Thought.md +++ /dev/null @@ -1,13 +0,0 @@ -# Thought - -Detailed thoughts/messages within this step. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**text** | **str** | The text content of this thought. | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/TimeSlicePartitionConfig.md b/gooddata-api-client/docs/TimeSlicePartitionConfig.md deleted file mode 100644 index 2f925a2fe..000000000 --- a/gooddata-api-client/docs/TimeSlicePartitionConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeSlicePartitionConfig - -Partition by time_slice() expression. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**column** | **str** | Column to partition on. | -**slices** | **int** | How many units per slice. | -**unit** | **str** | Date/time unit for partition granularity | -**type** | **str** | | defaults to "timeSlice" -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/UIContext.md b/gooddata-api-client/docs/UIContext.md deleted file mode 100644 index 35c989c34..000000000 --- a/gooddata-api-client/docs/UIContext.md +++ /dev/null @@ -1,13 +0,0 @@ -# UIContext - -Ambient UI state: what the user is currently looking at (dashboard, visible widgets). - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dashboard** | [**DashboardContext**](DashboardContext.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/UniqueKeyConfig.md b/gooddata-api-client/docs/UniqueKeyConfig.md deleted file mode 100644 index b78513aa0..000000000 --- a/gooddata-api-client/docs/UniqueKeyConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# UniqueKeyConfig - -Unique key model — enforces uniqueness, replaces on conflict. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **str** | | defaults to "unique" -**columns** | **[str]** | Key columns. Defaults to first inferred column. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/UserAuthorizationApi.md b/gooddata-api-client/docs/UserAuthorizationApi.md index a43cddf69..ed2fa433b 100644 --- a/gooddata-api-client/docs/UserAuthorizationApi.md +++ b/gooddata-api-client/docs/UserAuthorizationApi.md @@ -5,6 +5,7 @@ All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**get_profile**](UserAuthorizationApi.md#get_profile) | **GET** /api/v1/profile | Get Profile +[**process_invitation**](UserAuthorizationApi.md#process_invitation) | **POST** /api/v1/actions/invite | Invite User # **get_profile** @@ -70,3 +71,75 @@ 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) +# **process_invitation** +> process_invitation(invitation) + +Invite User + +Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint. + +### Example + + +```python +import time +import gooddata_api_client +from gooddata_api_client.api import user_authorization_api +from gooddata_api_client.model.invitation import Invitation +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 = user_authorization_api.UserAuthorizationApi(api_client) + invitation = Invitation( + email="email_example", + first_name="first_name_example", + force_send=True, + last_name="last_name_example", + user_id="user_id_example", + ) # Invitation | + + # example passing only required values which don't have defaults set + try: + # Invite User + api_instance.process_invitation(invitation) + except gooddata_api_client.ApiException as e: + print("Exception when calling UserAuthorizationApi->process_invitation: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **invitation** | [**Invitation**](Invitation.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | No Content | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/gooddata-api-client/docs/UserContext.md b/gooddata-api-client/docs/UserContext.md deleted file mode 100644 index 839e2e242..000000000 --- a/gooddata-api-client/docs/UserContext.md +++ /dev/null @@ -1,15 +0,0 @@ -# UserContext - -User context with ambient UI state (view) and explicitly referenced objects. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active_object** | [**ActiveObjectIdentification**](ActiveObjectIdentification.md) | | [optional] -**referenced_objects** | [**[ObjectReferenceGroup]**](ObjectReferenceGroup.md) | Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references). | [optional] -**view** | [**UIContext**](UIContext.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/UserDataFilterControllerApi.md b/gooddata-api-client/docs/UserDataFilterControllerApi.md index f798403dc..16d0be454 100644 --- a/gooddata-api-client/docs/UserDataFilterControllerApi.md +++ b/gooddata-api-client/docs/UserDataFilterControllerApi.md @@ -64,7 +64,7 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiUserDataFilterPostOptionalIdDocument | include = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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", @@ -214,7 +214,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -310,7 +310,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 = [ @@ -422,7 +422,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiUserDataFilterPatchDocument | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 @@ -628,7 +628,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiUserDataFilterInDocument | filter = "title==someString;description==someString;user.id==321;userGroup.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 = [ - "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single 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 diff --git a/gooddata-api-client/docs/UserSettingControllerApi.md b/gooddata-api-client/docs/UserSettingControllerApi.md index b193d6c4b..cb2b321d0 100644 --- a/gooddata-api-client/docs/UserSettingControllerApi.md +++ b/gooddata-api-client/docs/UserSettingControllerApi.md @@ -40,7 +40,7 @@ with gooddata_api_client.ApiClient() as api_client: user_id = "userId_example" # str | json_api_user_setting_in_document = JsonApiUserSettingInDocument( data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -349,7 +349,7 @@ with gooddata_api_client.ApiClient() as api_client: id = "/6bUUGjjNSwg0_bs" # str | json_api_user_setting_in_document = JsonApiUserSettingInDocument( data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), diff --git a/gooddata-api-client/docs/UserSettingsApi.md b/gooddata-api-client/docs/UserSettingsApi.md index 17f3d8997..9d8250dbc 100644 --- a/gooddata-api-client/docs/UserSettingsApi.md +++ b/gooddata-api-client/docs/UserSettingsApi.md @@ -123,7 +123,7 @@ with gooddata_api_client.ApiClient() as api_client: user_id = "userId_example" # str | json_api_user_setting_in_document = JsonApiUserSettingInDocument( data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -754,7 +754,7 @@ with gooddata_api_client.ApiClient() as api_client: id = "/6bUUGjjNSwg0_bs" # str | json_api_user_setting_in_document = JsonApiUserSettingInDocument( data=JsonApiUserSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), diff --git a/gooddata-api-client/docs/ValidateByItem.md b/gooddata-api-client/docs/ValidateByItem.md index 92021ad07..2c4af5ac3 100644 --- a/gooddata-api-client/docs/ValidateByItem.md +++ b/gooddata-api-client/docs/ValidateByItem.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | Specifies entity used for valid elements computation. | -**type** | **str** | Specifies entity type which could be label, attribute, fact, or metric. | +**type** | **str** | Specifies entity type which could be label, attribute, computedAttribute, fact, or metric. | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/gooddata-api-client/docs/VisualizationObjectApi.md b/gooddata-api-client/docs/VisualizationObjectApi.md index fe6b93689..0249269b2 100644 --- a/gooddata-api-client/docs/VisualizationObjectApi.md +++ b/gooddata-api-client/docs/VisualizationObjectApi.md @@ -44,6 +44,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectPostOptionalId( attributes=JsonApiVisualizationObjectInAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -57,10 +78,10 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiVisualizationObjectPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ - "metaInclude=origin,all", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -207,7 +228,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) 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 @@ -216,7 +237,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -303,11 +324,11 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -394,6 +415,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectPatch( attributes=JsonApiVisualizationObjectPatchAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -408,7 +450,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiVisualizationObjectPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -593,6 +635,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectIn( attributes=JsonApiVisualizationObjectInAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -607,7 +670,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiVisualizationObjectInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/VisualizationObjectControllerApi.md b/gooddata-api-client/docs/VisualizationObjectControllerApi.md index 4a840085f..a40ccc774 100644 --- a/gooddata-api-client/docs/VisualizationObjectControllerApi.md +++ b/gooddata-api-client/docs/VisualizationObjectControllerApi.md @@ -44,6 +44,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectPostOptionalId( attributes=JsonApiVisualizationObjectInAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -57,10 +78,10 @@ with gooddata_api_client.ApiClient() as api_client: ), ) # JsonApiVisualizationObjectPostOptionalIdDocument | include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) meta_include = [ - "metaInclude=origin,all", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -207,7 +228,7 @@ with gooddata_api_client.ApiClient() as api_client: origin = "ALL" # str | (optional) if omitted the server will use the default value of "ALL" filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) 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 @@ -216,7 +237,7 @@ with gooddata_api_client.ApiClient() as api_client: ] # [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", + "metaInclude=permissions,origin,page,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -303,11 +324,11 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) x_gdc_validate_relations = False # bool | (optional) if omitted the server will use the default value of False meta_include = [ - "metaInclude=origin,all", + "metaInclude=permissions,origin,all", ] # [str] | Include Meta objects. (optional) # example passing only required values which don't have defaults set @@ -394,6 +415,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectPatch( attributes=JsonApiVisualizationObjectPatchAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -408,7 +450,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiVisualizationObjectPatchDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set @@ -593,6 +635,27 @@ with gooddata_api_client.ApiClient() as api_client: data=JsonApiVisualizationObjectIn( attributes=JsonApiVisualizationObjectInAttributes( are_relations_valid=True, + conditional_formatting=JsonApiVisualizationObjectInAttributesConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content={}, description="description_example", is_hidden=True, @@ -607,7 +670,7 @@ with gooddata_api_client.ApiClient() as api_client: ) # JsonApiVisualizationObjectInDocument | filter = "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional) include = [ - "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", ] # [str] | Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together. (optional) # example passing only required values which don't have defaults set diff --git a/gooddata-api-client/docs/VisualizationPermissions.md b/gooddata-api-client/docs/VisualizationPermissions.md new file mode 100644 index 000000000..7f0586d93 --- /dev/null +++ b/gooddata-api-client/docs/VisualizationPermissions.md @@ -0,0 +1,14 @@ +# VisualizationPermissions + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rules** | [**[RulePermission]**](RulePermission.md) | List of rules | +**user_groups** | [**[UserGroupPermission]**](UserGroupPermission.md) | List of user groups | +**users** | [**[UserPermission]**](UserPermission.md) | List of users | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualizationPermissionsAssignment.md b/gooddata-api-client/docs/VisualizationPermissionsAssignment.md new file mode 100644 index 000000000..cb05e4b19 --- /dev/null +++ b/gooddata-api-client/docs/VisualizationPermissionsAssignment.md @@ -0,0 +1,13 @@ +# VisualizationPermissionsAssignment + +Desired levels of permissions on a visualization for an assignee. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualizationPermissionsForAssignee.md b/gooddata-api-client/docs/VisualizationPermissionsForAssignee.md new file mode 100644 index 000000000..b4b08ebf1 --- /dev/null +++ b/gooddata-api-client/docs/VisualizationPermissionsForAssignee.md @@ -0,0 +1,14 @@ +# VisualizationPermissionsForAssignee + +Desired levels of visualization permissions for an assignee identified by an identifier. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**assignee_identifier** | [**AssigneeIdentifier**](AssigneeIdentifier.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualizationPermissionsForAssigneeRule.md b/gooddata-api-client/docs/VisualizationPermissionsForAssigneeRule.md new file mode 100644 index 000000000..06453d021 --- /dev/null +++ b/gooddata-api-client/docs/VisualizationPermissionsForAssigneeRule.md @@ -0,0 +1,14 @@ +# VisualizationPermissionsForAssigneeRule + +Desired levels of visualization permissions for a collection of assignees identified by a rule. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**permissions** | **[str]** | | +**assignee_rule** | [**AssigneeRule**](AssigneeRule.md) | | +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md b/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md deleted file mode 100644 index ce757fd6f..000000000 --- a/gooddata-api-client/docs/VisualizationSwitcherWidgetDescriptor.md +++ /dev/null @@ -1,19 +0,0 @@ -# VisualizationSwitcherWidgetDescriptor - -Visualization switcher widget allowing users to toggle between multiple visualizations. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**active_visualization_id** | **str** | ID of the currently active visualization in the switcher. | -**title** | **str** | Widget title as displayed on the dashboard. | -**visualization_ids** | **[str]** | IDs of all visualizations available in the switcher. | -**widget_id** | **str** | Widget object ID. | -**widget_type** | **str** | | defaults to "visualizationSwitcher" -**filters** | [**[FilterDefinition]**](FilterDefinition.md) | Filters currently applied to the dashboard. | [optional] -**result_id** | **str** | Signed result ID for the currently active visualization's execution result. | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WhatIfMeasureAdjustmentConfig.md b/gooddata-api-client/docs/WhatIfMeasureAdjustmentConfig.md deleted file mode 100644 index 9022aa476..000000000 --- a/gooddata-api-client/docs/WhatIfMeasureAdjustmentConfig.md +++ /dev/null @@ -1,15 +0,0 @@ -# WhatIfMeasureAdjustmentConfig - -Measure adjustments for this scenario - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metric_id** | **str** | ID of the metric or fact to adjust | -**metric_type** | **str** | Type: metric or fact | -**scenario_maql** | **str** | Alternative MAQL expression for this scenario | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WhatIfScenarioConfig.md b/gooddata-api-client/docs/WhatIfScenarioConfig.md deleted file mode 100644 index d0dc7963f..000000000 --- a/gooddata-api-client/docs/WhatIfScenarioConfig.md +++ /dev/null @@ -1,14 +0,0 @@ -# WhatIfScenarioConfig - -What-if scenario configuration. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_baseline** | **bool** | Whether baseline (unmodified) values are included | -**scenarios** | [**[WhatIfScenarioItem]**](WhatIfScenarioItem.md) | Scenarios with alternative measure calculations | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WhatIfScenarioItem.md b/gooddata-api-client/docs/WhatIfScenarioItem.md deleted file mode 100644 index f292bafb7..000000000 --- a/gooddata-api-client/docs/WhatIfScenarioItem.md +++ /dev/null @@ -1,14 +0,0 @@ -# WhatIfScenarioItem - -Scenarios with alternative measure calculations - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**adjustments** | [**[WhatIfMeasureAdjustmentConfig]**](WhatIfMeasureAdjustmentConfig.md) | Measure adjustments for this scenario | -**label** | **str** | Human-readable scenario label | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WorkflowDashboardSummaryRequestDto.md b/gooddata-api-client/docs/WorkflowDashboardSummaryRequestDto.md deleted file mode 100644 index 7c0fdecd3..000000000 --- a/gooddata-api-client/docs/WorkflowDashboardSummaryRequestDto.md +++ /dev/null @@ -1,15 +0,0 @@ -# WorkflowDashboardSummaryRequestDto - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dashboard_id** | **str** | | -**custom_user_prompt** | **str** | | [optional] -**key_metric_ids** | **[str]** | | [optional] -**reference_quarter** | **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/WorkflowDashboardSummaryResponseDto.md b/gooddata-api-client/docs/WorkflowDashboardSummaryResponseDto.md deleted file mode 100644 index f23141465..000000000 --- a/gooddata-api-client/docs/WorkflowDashboardSummaryResponseDto.md +++ /dev/null @@ -1,14 +0,0 @@ -# WorkflowDashboardSummaryResponseDto - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**run_id** | **str** | | -**status** | **str** | | -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WorkflowStatusResponseDto.md b/gooddata-api-client/docs/WorkflowStatusResponseDto.md deleted file mode 100644 index cdb4bd331..000000000 --- a/gooddata-api-client/docs/WorkflowStatusResponseDto.md +++ /dev/null @@ -1,17 +0,0 @@ -# WorkflowStatusResponseDto - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**run_id** | **str** | | -**status** | **str** | | -**current_phase** | **str** | | [optional] -**error** | **str** | | [optional] -**result** | **{str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}** | | [optional] -**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/gooddata-api-client/docs/WorkspaceSettingControllerApi.md b/gooddata-api-client/docs/WorkspaceSettingControllerApi.md index 996b37d00..4334a415a 100644 --- a/gooddata-api-client/docs/WorkspaceSettingControllerApi.md +++ b/gooddata-api-client/docs/WorkspaceSettingControllerApi.md @@ -42,7 +42,7 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -374,7 +374,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -563,7 +563,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), diff --git a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md index c92fb0ba0..7d320ef8e 100644 --- a/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md +++ b/gooddata-api-client/docs/WorkspacesDeclarativeAPIsApi.md @@ -247,6 +247,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -327,6 +363,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -365,6 +416,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -374,6 +463,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -444,6 +554,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -454,6 +579,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -569,6 +709,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", @@ -714,6 +869,11 @@ with gooddata_api_client.ApiClient() as api_client: ], ), interval="DAY", + settings=ExecutionSettings( + data_sampling_percentage=0, + timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'), + timezone="Europe/Prague", + ), trigger="ALWAYS", ), analytical_dashboard=DeclarativeAnalyticalDashboardIdentifier( @@ -912,6 +1072,27 @@ with gooddata_api_client.ApiClient() as api_client: tabular_exports=[ AutomationTabularExport( request_payload=TabularExportRequest( + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), custom_override=CustomOverride( labels={ "key": CustomLabel( @@ -1191,6 +1372,42 @@ with gooddata_api_client.ApiClient() as api_client: title="Count of goods", ), ], + computed_attributes=[ + DeclarativeComputedAttribute( + certification="CERTIFIED", + certification_message="certification_message_example", + certified_at="0480-72-88 80:01", + certified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + content=DeclarativeComputedAttributeContent( + format="%0.2f", + maql="SELECT 1", + metric_type="UNSPECIFIED", + ), + created_at="2023-07-20 12:30", + created_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + data_type="STRING", + description="Sales for all the data available.", + id="total-sales", + is_hidden=False, + is_nullable=False, + locale="en-US", + modified_at="2023-07-20 12:30", + modified_by=DeclarativeUserIdentifier( + id="employee123", + type="user", + ), + null_value="empty_value", + tags=["Revenues"], + title="Total sales", + value_type="TEXT", + ), + ], dashboard_plugins=[ DeclarativeDashboardPlugin( content=JsonNode(), @@ -1271,6 +1488,21 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -1309,6 +1541,44 @@ with gooddata_api_client.ApiClient() as api_client: title="Discount Rate", ), ], + report_page_layouts=[ + DeclarativeReportPageLayout( + content=JsonNode(), + description="description_example", + id="brand-cover", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + report_templates=[ + DeclarativeReportTemplate( + content=JsonNode(), + description="description_example", + id="quarterly-review-template", + tags=[ + "["brand"]", + ], + title="title_example", + ), + ], + reports=[ + DeclarativeReport( + content=JsonNode(), + description="description_example", + id="quarterly-review-2026-h1", + period_end=dateutil_parser('Tue Jun 30 00:00:00 UTC 2026').date(), + period_start=dateutil_parser('Thu Jan 01 00:00:00 UTC 2026').date(), + tags=[ + "["brand"]", + ], + title="title_example", + variable_values={ + "key": "key_example", + }, + ), + ], visualization_objects=[ DeclarativeVisualizationObject( certification="CERTIFIED", @@ -1318,6 +1588,27 @@ with gooddata_api_client.ApiClient() as api_client: id="employee123", type="user", ), + conditional_formatting=ConditionalFormatting( + enabled=True, + rules=[ + ConditionalFormattingRule( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + id="bb955b38-a9e6-45f5-b068-155cb7ce509a", + target=ConditionalFormattingTarget(), + ), + ], + ), content=JsonNode(), created_at="2023-07-20 12:30", created_by=DeclarativeUserIdentifier( @@ -1388,6 +1679,21 @@ with gooddata_api_client.ApiClient() as api_client: ], attributes=[ DeclarativeAttribute( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), default_view=LabelIdentifier( id="label_id", type="label", @@ -1398,6 +1704,21 @@ with gooddata_api_client.ApiClient() as api_client: is_nullable=False, labels=[ DeclarativeLabel( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="Customer name", geo_area_config=GeoAreaConfig( collection=GeoCollectionIdentifier( @@ -1513,6 +1834,21 @@ with gooddata_api_client.ApiClient() as api_client: ], date_instances=[ DeclarativeDateDataset( + conditional_formatting=ObjectConditionalFormatting( + conditions=[ + ConditionalFormattingCondition( + format=ConditionalFormattingFormat( + background_color="#3DB36B", + color="#E54D40", + scope="cell", + ), + id="d0538854-aac3-4fc6-9603-61f49bab6aa3", + operator="ALL", + value=ConditionalFormattingValue(), + ), + ], + enabled=True, + ), description="A customer order date", granularities=[ "SECOND", diff --git a/gooddata-api-client/docs/WorkspacesSettingsApi.md b/gooddata-api-client/docs/WorkspacesSettingsApi.md index 5cc0e23a9..4044f6971 100644 --- a/gooddata-api-client/docs/WorkspacesSettingsApi.md +++ b/gooddata-api-client/docs/WorkspacesSettingsApi.md @@ -141,7 +141,7 @@ with gooddata_api_client.ApiClient() as api_client: workspace_id = "workspaceId_example" # str | json_api_workspace_setting_post_optional_id_document = JsonApiWorkspaceSettingPostOptionalIdDocument( data=JsonApiWorkspaceSettingPostOptionalId( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -804,7 +804,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_workspace_setting_patch_document = JsonApiWorkspaceSettingPatchDocument( data=JsonApiWorkspaceSettingPatch( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), @@ -1182,7 +1182,7 @@ with gooddata_api_client.ApiClient() as api_client: object_id = "objectId_example" # str | json_api_workspace_setting_in_document = JsonApiWorkspaceSettingInDocument( data=JsonApiWorkspaceSettingIn( - attributes=JsonApiOrganizationSettingInAttributes( + attributes=JsonApiUserSettingInAttributes( content={}, type="TIMEZONE", ), diff --git a/gooddata-api-client/gooddata_api_client/api/__init__.py b/gooddata-api-client/gooddata_api_client/api/__init__.py index ec1c32836..dacd523f5 100644 --- a/gooddata-api-client/gooddata_api_client/api/__init__.py +++ b/gooddata-api-client/gooddata_api_client/api/__init__.py @@ -1,3 +1,3 @@ # do not import all apis into this module because that uses a lot of memory and stack frames # if you need the ability to import all apis from one package, import them with -# from gooddata_api_client.apis import AIApi +# from gooddata_api_client.apis import AILakeApi 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 848e997d7..d363bf7e3 100644 --- a/gooddata-api-client/gooddata_api_client/api/actions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/actions_api.py @@ -42,15 +42,11 @@ from gooddata_api_client.model.change_analysis_request import ChangeAnalysisRequest from gooddata_api_client.model.change_analysis_response import ChangeAnalysisResponse from gooddata_api_client.model.change_analysis_result import ChangeAnalysisResult -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse from gooddata_api_client.model.clustering_request import ClusteringRequest from gooddata_api_client.model.clustering_result import ClusteringResult from gooddata_api_client.model.column_statistics_request import ColumnStatisticsRequest from gooddata_api_client.model.column_statistics_response import ColumnStatisticsResponse +from gooddata_api_client.model.computed_attribute_permissions import ComputedAttributePermissions from gooddata_api_client.model.convert_geo_file_request import ConvertGeoFileRequest from gooddata_api_client.model.convert_geo_file_response import ConvertGeoFileResponse from gooddata_api_client.model.dashboard_permissions import DashboardPermissions @@ -67,6 +63,11 @@ from gooddata_api_client.model.execution_result import ExecutionResult from gooddata_api_client.model.export_response import ExportResponse from gooddata_api_client.model.fact_permissions import FactPermissions +from gooddata_api_client.model.flow_execution_response import FlowExecutionResponse +from gooddata_api_client.model.flow_operations import FlowOperations +from gooddata_api_client.model.flow_request import FlowRequest +from gooddata_api_client.model.flow_result_metadata import FlowResultMetadata +from gooddata_api_client.model.flow_table_result import FlowTableResult from gooddata_api_client.model.forecast_request import ForecastRequest from gooddata_api_client.model.forecast_result import ForecastResult from gooddata_api_client.model.gd_storage_file import GdStorageFile @@ -84,6 +85,7 @@ 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.invitation import Invitation from gooddata_api_client.model.ip_allowlist_policy_targets import IpAllowlistPolicyTargets from gooddata_api_client.model.key_drivers_request import KeyDriversRequest from gooddata_api_client.model.key_drivers_response import KeyDriversResponse @@ -93,10 +95,12 @@ 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.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 from gooddata_api_client.model.manage_fact_permissions_request_inner import ManageFactPermissionsRequestInner from gooddata_api_client.model.manage_label_permissions_request_inner import ManageLabelPermissionsRequestInner from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner +from gooddata_api_client.model.manage_visualization_permissions_request_inner import ManageVisualizationPermissionsRequestInner from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers from gooddata_api_client.model.metric_permissions import MetricPermissions from gooddata_api_client.model.notifications import Notifications @@ -111,16 +115,14 @@ from gooddata_api_client.model.raw_export_request import RawExportRequest from gooddata_api_client.model.read_csv_file_manifests_request import ReadCsvFileManifestsRequest from gooddata_api_client.model.read_csv_file_manifests_response import ReadCsvFileManifestsResponse +from gooddata_api_client.model.report_export_request import ReportExportRequest from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest -from gooddata_api_client.model.resolved_llms import ResolvedLlms from gooddata_api_client.model.resolved_setting import ResolvedSetting from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata from gooddata_api_client.model.scan_request import ScanRequest from gooddata_api_client.model.scan_result_pdm import ScanResultPdm from gooddata_api_client.model.scan_sql_request import ScanSqlRequest from gooddata_api_client.model.scan_sql_response import ScanSqlResponse -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult from gooddata_api_client.model.set_certification_request import SetCertificationRequest from gooddata_api_client.model.slides_export_request import SlidesExportRequest from gooddata_api_client.model.smart_function_response import SmartFunctionResponse @@ -142,9 +144,7 @@ from gooddata_api_client.model.upload_geo_collection_file_response import UploadGeoCollectionFileResponse from gooddata_api_client.model.visual_export_request import VisualExportRequest from gooddata_api_client.model.visualization_object_execution import VisualizationObjectExecution -from gooddata_api_client.model.workflow_dashboard_summary_request_dto import WorkflowDashboardSummaryRequestDto -from gooddata_api_client.model.workflow_dashboard_summary_response_dto import WorkflowDashboardSummaryResponseDto -from gooddata_api_client.model.workflow_status_response_dto import WorkflowStatusResponseDto +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_permission_assignment import WorkspacePermissionAssignment from gooddata_api_client.model.workspace_user_groups import WorkspaceUserGroups @@ -219,7 +219,7 @@ def __init__(self, api_client=None): ) self.ai_chat_endpoint = _Endpoint( settings={ - 'response_type': (ChatResult,), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chat', 'operation_id': 'ai_chat', @@ -229,11 +229,9 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', - 'chat_request', ], 'required': [ 'workspace_id', - 'chat_request', ], 'nullable': [ ], @@ -257,32 +255,25 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'chat_request': - (ChatRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'chat_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) self.ai_chat_history_endpoint = _Endpoint( settings={ - 'response_type': (ChatHistoryResult,), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory', 'operation_id': 'ai_chat_history', @@ -292,11 +283,9 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', - 'chat_history_request', ], 'required': [ 'workspace_id', - 'chat_history_request', ], 'nullable': [ ], @@ -320,32 +309,25 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'chat_history_request': - (ChatHistoryRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'chat_history_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) self.ai_chat_stream_endpoint = _Endpoint( settings={ - 'response_type': ([dict],), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatStream', 'operation_id': 'ai_chat_stream', @@ -355,11 +337,9 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', - 'chat_request', ], 'required': [ 'workspace_id', - 'chat_request', ], 'nullable': [ ], @@ -383,32 +363,25 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'chat_request': - (ChatRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'chat_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'text/event-stream' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) self.ai_chat_usage_endpoint = _Endpoint( settings={ - 'response_type': (ChatUsageResponse,), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage', 'operation_id': 'ai_chat_usage', @@ -455,76 +428,11 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client ) - self.ai_search_endpoint = _Endpoint( - settings={ - 'response_type': (SearchResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/search', - 'operation_id': 'ai_search', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'search_request', - ], - 'required': [ - 'workspace_id', - 'search_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'search_request': - (SearchRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'search_request': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) self.all_platform_usage_endpoint = _Endpoint( settings={ 'response_type': ([PlatformUsage],), @@ -936,23 +844,23 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.cancel_workflow_endpoint = _Endpoint( + self.cancel_flows_endpoint = _Endpoint( settings={ - 'response_type': ({str: (str,)},), + 'response_type': (AfmCancelTokens,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/cancel', - 'operation_id': 'cancel_workflow', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel', + 'operation_id': 'cancel_flows', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'run_id', + 'afm_cancel_tokens', ], 'required': [ 'workspace_id', - 'run_id', + 'afm_cancel_tokens', ], 'nullable': [ ], @@ -976,16 +884,15 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'run_id': - (str,), + 'afm_cancel_tokens': + (AfmCancelTokens,), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'run_id': 'runId', }, 'location_map': { 'workspace_id': 'path', - 'run_id': 'path', + 'afm_cancel_tokens': 'body', }, 'collection_format_map': { } @@ -994,7 +901,9 @@ def __init__(self, api_client=None): 'accept': [ 'application/json' ], - 'content_type': [], + 'content_type': [ + 'application/json' + ] }, api_client=api_client ) @@ -1839,6 +1748,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.computed_attribute_permissions_endpoint = _Endpoint( + settings={ + 'response_type': (ComputedAttributePermissions,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions', + 'operation_id': 'computed_attribute_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'computed_attribute_id', + ], + 'required': [ + 'workspace_id', + 'computed_attribute_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'computed_attribute_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'computed_attribute_id': 'computedAttributeId', + }, + 'location_map': { + 'workspace_id': 'path', + 'computed_attribute_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.convert_geo_file_endpoint = _Endpoint( settings={ 'response_type': (ConvertGeoFileResponse,), @@ -1964,6 +1928,7 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'image_export_request', + 'x_gdc_debug', ], 'required': [ 'workspace_id', @@ -1986,13 +1951,17 @@ def __init__(self, api_client=None): (str,), 'image_export_request': (ImageExportRequest,), + 'x_gdc_debug': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', }, 'location_map': { 'workspace_id': 'path', 'image_export_request': 'body', + 'x_gdc_debug': 'header', }, 'collection_format_map': { } @@ -2124,6 +2093,67 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_report_export_endpoint = _Endpoint( + settings={ + 'response_type': (ExportResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/report', + 'operation_id': 'create_report_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_slides_export_endpoint = _Endpoint( settings={ 'response_type': (ExportResponse,), @@ -2552,6 +2582,69 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.execute_flow_endpoint = _Endpoint( + settings={ + 'response_type': (FlowExecutionResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow', + 'operation_id': 'execute_flow', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'flow_request', + ], + 'required': [ + 'workspace_id', + 'flow_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'flow_request': + (FlowRequest,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + }, + 'location_map': { + 'workspace_id': 'path', + 'flow_request': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.explain_afm_endpoint = _Endpoint( settings={ 'response_type': None, @@ -2841,72 +2934,9 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.generate_dashboard_summary_endpoint = _Endpoint( + self.generate_description_endpoint = _Endpoint( settings={ - 'response_type': (WorkflowDashboardSummaryResponseDto,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary', - 'operation_id': 'generate_dashboard_summary', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'workflow_dashboard_summary_request_dto', - ], - 'required': [ - 'workspace_id', - 'workflow_dashboard_summary_request_dto', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'workflow_dashboard_summary_request_dto': - (WorkflowDashboardSummaryRequestDto,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'workflow_dashboard_summary_request_dto': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.generate_description_endpoint = _Endpoint( - settings={ - 'response_type': (GenerateDescriptionResponse,), + 'response_type': (GenerateDescriptionResponse,), 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription', 'operation_id': 'generate_description', @@ -3729,12 +3759,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_slides_export_endpoint = _Endpoint( + self.get_report_export_endpoint = _Endpoint( settings={ 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', - 'operation_id': 'get_slides_export', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}', + 'operation_id': 'get_report_export', 'http_method': 'GET', 'servers': None, }, @@ -3778,20 +3808,18 @@ def __init__(self, api_client=None): }, headers_map={ 'accept': [ - 'application/pdf', - 'application/vnd.openxmlformats-officedocument.presentationml.presentation', - 'application/zip' + 'application/pdf' ], 'content_type': [], }, api_client=api_client ) - self.get_slides_export_metadata_endpoint = _Endpoint( + self.get_report_export_metadata_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata', - 'operation_id': 'get_slides_export_metadata', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata', + 'operation_id': 'get_report_export_metadata', 'http_method': 'GET', 'servers': None, }, @@ -3841,12 +3869,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_tabular_export_endpoint = _Endpoint( + self.get_slides_export_endpoint = _Endpoint( settings={ 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', - 'operation_id': 'get_tabular_export', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}', + 'operation_id': 'get_slides_export', 'http_method': 'GET', 'servers': None, }, @@ -3891,30 +3919,30 @@ def __init__(self, api_client=None): headers_map={ 'accept': [ 'application/pdf', - 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', - 'application/zip', - 'text/csv', - 'text/html' + 'application/vnd.openxmlformats-officedocument.presentationml.presentation', + 'application/zip' ], 'content_type': [], }, api_client=api_client ) - self.get_translation_tags_endpoint = _Endpoint( + self.get_slides_export_metadata_endpoint = _Endpoint( settings={ - 'response_type': ([str],), + 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations', - 'operation_id': 'get_translation_tags', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata', + 'operation_id': 'get_slides_export_metadata', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', + 'export_id', ], 'required': [ 'workspace_id', + 'export_id', ], 'nullable': [ ], @@ -3931,12 +3959,16 @@ def __init__(self, api_client=None): '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': { } @@ -3949,56 +3981,102 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_workflow_status_endpoint = _Endpoint( + self.get_tabular_export_endpoint = _Endpoint( settings={ - 'response_type': (WorkflowStatusResponseDto,), + 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/status', - 'operation_id': 'get_workflow_status', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}', + 'operation_id': 'get_tabular_export', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'run_id', + 'export_id', ], 'required': [ 'workspace_id', - 'run_id', + 'export_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ - 'workspace_id', ] }, root_map={ 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { }, 'openapi_types': { 'workspace_id': (str,), - 'run_id': + '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', + 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', + 'application/zip', + 'text/csv', + 'text/html' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_translation_tags_endpoint = _Endpoint( + settings={ + 'response_type': ([str],), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations', + 'operation_id': 'get_translation_tags', + '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', - 'run_id': 'runId', }, 'location_map': { 'workspace_id': 'path', - 'run_id': 'path', }, 'collection_format_map': { } @@ -4465,6 +4543,62 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.list_flow_operations_endpoint = _Endpoint( + settings={ + 'response_type': (FlowOperations,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/operations', + 'operation_id': 'list_flow_operations', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + }, + '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.list_llm_provider_models_endpoint = _Endpoint( settings={ 'response_type': (ListLlmProviderModelsResponse,), @@ -4752,25 +4886,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.manage_dashboard_permissions_endpoint = _Endpoint( + self.manage_computed_attribute_permissions_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions', - 'operation_id': 'manage_dashboard_permissions', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions', + 'operation_id': 'manage_computed_attribute_permissions', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'dashboard_id', - 'manage_dashboard_permissions_request_inner', + 'computed_attribute_id', + 'manage_computed_attribute_permissions_request_inner', ], 'required': [ 'workspace_id', - 'dashboard_id', - 'manage_dashboard_permissions_request_inner', + 'computed_attribute_id', + 'manage_computed_attribute_permissions_request_inner', ], 'nullable': [ ], @@ -4787,19 +4921,19 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'dashboard_id': + 'computed_attribute_id': (str,), - 'manage_dashboard_permissions_request_inner': - ([ManageDashboardPermissionsRequestInner],), + 'manage_computed_attribute_permissions_request_inner': + ([ManageComputedAttributePermissionsRequestInner],), }, 'attribute_map': { 'workspace_id': 'workspaceId', - 'dashboard_id': 'dashboardId', + 'computed_attribute_id': 'computedAttributeId', }, 'location_map': { 'workspace_id': 'path', - 'dashboard_id': 'path', - 'manage_dashboard_permissions_request_inner': 'body', + 'computed_attribute_id': 'path', + 'manage_computed_attribute_permissions_request_inner': 'body', }, 'collection_format_map': { } @@ -4812,23 +4946,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.manage_data_source_permissions_endpoint = _Endpoint( + self.manage_dashboard_permissions_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/managePermissions', - 'operation_id': 'manage_data_source_permissions', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions', + 'operation_id': 'manage_dashboard_permissions', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'data_source_id', - 'data_source_permission_assignment', + 'workspace_id', + 'dashboard_id', + 'manage_dashboard_permissions_request_inner', ], 'required': [ - 'data_source_id', - 'data_source_permission_assignment', + 'workspace_id', + 'dashboard_id', + 'manage_dashboard_permissions_request_inner', ], 'nullable': [ ], @@ -4843,19 +4979,77 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'data_source_id': + 'workspace_id': (str,), - 'data_source_permission_assignment': - ([DataSourcePermissionAssignment],), + 'dashboard_id': + (str,), + 'manage_dashboard_permissions_request_inner': + ([ManageDashboardPermissionsRequestInner],), }, 'attribute_map': { - 'data_source_id': 'dataSourceId', + 'workspace_id': 'workspaceId', + 'dashboard_id': 'dashboardId', }, 'location_map': { - 'data_source_id': 'path', - 'data_source_permission_assignment': 'body', - }, - 'collection_format_map': { + 'workspace_id': 'path', + 'dashboard_id': 'path', + 'manage_dashboard_permissions_request_inner': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.manage_data_source_permissions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/dataSources/{dataSourceId}/managePermissions', + 'operation_id': 'manage_data_source_permissions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'data_source_id', + 'data_source_permission_assignment', + ], + 'required': [ + 'data_source_id', + 'data_source_permission_assignment', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'data_source_id': + (str,), + 'data_source_permission_assignment': + ([DataSourcePermissionAssignment],), + }, + 'attribute_map': { + 'data_source_id': 'dataSourceId', + }, + 'location_map': { + 'data_source_id': 'path', + 'data_source_permission_assignment': 'body', + }, + 'collection_format_map': { } }, headers_map={ @@ -5094,6 +5288,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.manage_visualization_permissions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions', + 'operation_id': 'manage_visualization_permissions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'visualization_object_id', + 'manage_visualization_permissions_request_inner', + ], + 'required': [ + 'workspace_id', + 'visualization_object_id', + 'manage_visualization_permissions_request_inner', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'visualization_object_id': + (str,), + 'manage_visualization_permissions_request_inner': + ([ManageVisualizationPermissionsRequestInner],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'visualization_object_id': 'visualizationObjectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'visualization_object_id': 'path', + 'manage_visualization_permissions_request_inner': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.manage_workspace_permissions_endpoint = _Endpoint( settings={ 'response_type': None, @@ -5692,6 +5946,54 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.process_invitation_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/invite', + 'operation_id': 'process_invitation', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'invitation', + ], + 'required': [ + 'invitation', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'invitation': + (Invitation,), + }, + 'attribute_map': { + }, + 'location_map': { + 'invitation': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.read_csv_file_manifests_endpoint = _Endpoint( settings={ 'response_type': ([ReadCsvFileManifestsResponse],), @@ -6079,62 +6381,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.resolve_llm_providers_endpoint = _Endpoint( - settings={ - 'response_type': (ResolvedLlms,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders', - 'operation_id': 'resolve_llm_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - '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.resolve_requested_entitlements_endpoint = _Endpoint( settings={ 'response_type': ([ApiEntitlement],), @@ -6302,12 +6548,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.retrieve_result_endpoint = _Endpoint( + self.retrieve_flow_result_binary_endpoint = _Endpoint( settings={ - 'response_type': (ExecutionResult,), + 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}', - 'operation_id': 'retrieve_result', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary', + 'operation_id': 'retrieve_flow_result_binary', 'http_method': 'GET', 'servers': None, }, @@ -6315,10 +6561,10 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'result_id', - 'offset', - 'limit', - 'excluded_total_dimensions', - 'x_gdc_cancel_token', + 'row_offset', + 'row_limit', + 'column_offset', + 'column_limit', ], 'required': [ 'workspace_id', @@ -6348,51 +6594,49 @@ def __init__(self, api_client=None): (str,), 'result_id': (str,), - 'offset': - ([int],), - 'limit': - ([int],), - 'excluded_total_dimensions': - ([str],), - 'x_gdc_cancel_token': - (str,), + 'row_offset': + (int,), + 'row_limit': + (int,), + 'column_offset': + (int,), + 'column_limit': + (int,), }, 'attribute_map': { 'workspace_id': 'workspaceId', 'result_id': 'resultId', - 'offset': 'offset', - 'limit': 'limit', - 'excluded_total_dimensions': 'excludedTotalDimensions', - 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', + 'row_offset': 'rowOffset', + 'row_limit': 'rowLimit', + 'column_offset': 'columnOffset', + 'column_limit': 'columnLimit', }, 'location_map': { 'workspace_id': 'path', 'result_id': 'path', - 'offset': 'query', - 'limit': 'query', - 'excluded_total_dimensions': 'query', - 'x_gdc_cancel_token': 'header', + 'row_offset': 'query', + 'row_limit': 'query', + 'column_offset': 'query', + 'column_limit': 'query', }, 'collection_format_map': { - 'offset': 'csv', - 'limit': 'csv', - 'excluded_total_dimensions': 'csv', } }, headers_map={ 'accept': [ - 'application/json' + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream' ], 'content_type': [], }, api_client=api_client ) - self.retrieve_result_binary_endpoint = _Endpoint( + self.retrieve_flow_result_metadata_endpoint = _Endpoint( settings={ - 'response_type': (file_type,), + 'response_type': (FlowResultMetadata,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary', - 'operation_id': 'retrieve_result_binary', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata', + 'operation_id': 'retrieve_flow_result_metadata', 'http_method': 'GET', 'servers': None, }, @@ -6400,7 +6644,6 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'result_id', - 'x_gdc_cancel_token', ], 'required': [ 'workspace_id', @@ -6430,38 +6673,268 @@ def __init__(self, api_client=None): (str,), 'result_id': (str,), - 'x_gdc_cancel_token': - (str,), }, 'attribute_map': { 'workspace_id': 'workspaceId', 'result_id': 'resultId', - 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', }, 'location_map': { 'workspace_id': 'path', 'result_id': 'path', - 'x_gdc_cancel_token': 'header', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'application/vnd.apache.arrow.file', - 'application/vnd.apache.arrow.stream' + 'application/json' ], 'content_type': [], }, api_client=api_client ) - self.retrieve_translations_endpoint = _Endpoint( + self.retrieve_flow_result_table_endpoint = _Endpoint( settings={ - 'response_type': (Xliff,), + 'response_type': (FlowTableResult,), 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/retrieve', - 'operation_id': 'retrieve_translations', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table', + 'operation_id': 'retrieve_flow_result_table', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'result_id', + 'row_offset', + 'row_limit', + 'column_offset', + 'column_limit', + ], + 'required': [ + 'workspace_id', + 'result_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'result_id': + (str,), + 'row_offset': + (int,), + 'row_limit': + (int,), + 'column_offset': + (int,), + 'column_limit': + (int,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'result_id': 'resultId', + 'row_offset': 'rowOffset', + 'row_limit': 'rowLimit', + 'column_offset': 'columnOffset', + 'column_limit': 'columnLimit', + }, + 'location_map': { + 'workspace_id': 'path', + 'result_id': 'path', + 'row_offset': 'query', + 'row_limit': 'query', + 'column_offset': 'query', + 'column_limit': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.retrieve_result_endpoint = _Endpoint( + settings={ + 'response_type': (ExecutionResult,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}', + 'operation_id': 'retrieve_result', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'result_id', + 'offset', + 'limit', + 'excluded_total_dimensions', + 'x_gdc_cancel_token', + ], + 'required': [ + 'workspace_id', + 'result_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'result_id': + (str,), + 'offset': + ([int],), + 'limit': + ([int],), + 'excluded_total_dimensions': + ([str],), + 'x_gdc_cancel_token': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'result_id': 'resultId', + 'offset': 'offset', + 'limit': 'limit', + 'excluded_total_dimensions': 'excludedTotalDimensions', + 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', + }, + 'location_map': { + 'workspace_id': 'path', + 'result_id': 'path', + 'offset': 'query', + 'limit': 'query', + 'excluded_total_dimensions': 'query', + 'x_gdc_cancel_token': 'header', + }, + 'collection_format_map': { + 'offset': 'csv', + 'limit': 'csv', + 'excluded_total_dimensions': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.retrieve_result_binary_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary', + 'operation_id': 'retrieve_result_binary', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'result_id', + 'x_gdc_cancel_token', + ], + 'required': [ + 'workspace_id', + 'result_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'workspace_id', + ] + }, + root_map={ + 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'result_id': + (str,), + 'x_gdc_cancel_token': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'result_id': 'resultId', + 'x_gdc_cancel_token': 'X-GDC-CANCEL-TOKEN', + }, + 'location_map': { + 'workspace_id': 'path', + 'result_id': 'path', + 'x_gdc_cancel_token': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.retrieve_translations_endpoint = _Endpoint( + settings={ + 'response_type': (Xliff,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/translations/retrieve', + 'operation_id': 'retrieve_translations', + 'http_method': 'POST', 'servers': None, }, params_map={ @@ -6900,6 +7373,46 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.sync_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/syncMetadata', + 'operation_id': 'sync_metadata', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) self.tags_endpoint = _Endpoint( settings={ 'response_type': (AnalyticsCatalogTags,), @@ -7922,6 +8435,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.visualization_permissions_endpoint = _Endpoint( + settings={ + 'response_type': (VisualizationPermissions,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions', + 'operation_id': 'visualization_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'visualization_object_id', + ], + 'required': [ + 'workspace_id', + 'visualization_object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'visualization_object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'visualization_object_id': 'visualizationObjectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'visualization_object_id': 'path', + }, + '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],), @@ -8127,21 +8695,19 @@ def add_targets( def ai_chat( self, workspace_id, - chat_request, **kwargs ): - """(BETA) Chat with AI # noqa: E501 + """(REMOVED) Chat with AI # noqa: E501 - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 + Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.ai_chat(workspace_id, chat_request, async_req=True) + >>> thread = api.ai_chat(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - chat_request (ChatRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -8176,7 +8742,7 @@ def ai_chat( async_req (bool): execute request asynchronously Returns: - ChatResult + None If the method is called asynchronously, returns the request thread. """ @@ -8207,28 +8773,24 @@ def ai_chat( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['chat_request'] = \ - chat_request return self.ai_chat_endpoint.call_with_http_info(**kwargs) def ai_chat_history( self, workspace_id, - chat_history_request, **kwargs ): - """(BETA) Get Chat History # noqa: E501 + """(REMOVED) Get Chat History # noqa: E501 - (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. # noqa: E501 + Removed. Chat history is served by the AI Assistant API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.ai_chat_history(workspace_id, chat_history_request, async_req=True) + >>> thread = api.ai_chat_history(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - chat_history_request (ChatHistoryRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -8263,7 +8825,7 @@ def ai_chat_history( async_req (bool): execute request asynchronously Returns: - ChatHistoryResult + None If the method is called asynchronously, returns the request thread. """ @@ -8294,28 +8856,24 @@ def ai_chat_history( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['chat_history_request'] = \ - chat_history_request return self.ai_chat_history_endpoint.call_with_http_info(**kwargs) def ai_chat_stream( self, workspace_id, - chat_request, **kwargs ): - """(BETA) Chat with AI # noqa: E501 + """(REMOVED) Chat with AI # noqa: E501 - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 + Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.ai_chat_stream(workspace_id, chat_request, async_req=True) + >>> thread = api.ai_chat_stream(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - chat_request (ChatRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -8350,7 +8908,7 @@ def ai_chat_stream( async_req (bool): execute request asynchronously Returns: - [dict] + None If the method is called asynchronously, returns the request thread. """ @@ -8381,8 +8939,6 @@ def ai_chat_stream( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['chat_request'] = \ - chat_request return self.ai_chat_stream_endpoint.call_with_http_info(**kwargs) def ai_chat_usage( @@ -8390,9 +8946,9 @@ def ai_chat_usage( workspace_id, **kwargs ): - """Get Chat Usage # noqa: E501 + """(REMOVED) Get Chat Usage # noqa: E501 - Returns usage statistics of chat for a user in a workspace. # noqa: E501 + Removed. Chat usage is served by the AI Assistant API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -8435,7 +8991,7 @@ def ai_chat_usage( async_req (bool): execute request asynchronously Returns: - ChatUsageResponse + None If the method is called asynchronously, returns the request thread. """ @@ -8468,93 +9024,6 @@ def ai_chat_usage( workspace_id return self.ai_chat_usage_endpoint.call_with_http_info(**kwargs) - def ai_search( - self, - workspace_id, - search_request, - **kwargs - ): - """(BETA) Semantic Search in Metadata # noqa: E501 - - (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_search(workspace_id, search_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - search_request (SearchRequest): - - 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: - SearchResult - 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['search_request'] = \ - search_request - return self.ai_search_endpoint.call_with_http_info(**kwargs) - def all_platform_usage( self, **kwargs @@ -9156,23 +9625,24 @@ def cancel_executions( afm_cancel_tokens return self.cancel_executions_endpoint.call_with_http_info(**kwargs) - def cancel_workflow( + def cancel_flows( self, workspace_id, - run_id, + afm_cancel_tokens, **kwargs ): - """cancel_workflow # noqa: E501 + """(EXPERIMENTAL) Apply the given cancel tokens to flows # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.cancel_workflow(workspace_id, run_id, async_req=True) + >>> thread = api.cancel_flows(workspace_id, afm_cancel_tokens, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - run_id (str): + afm_cancel_tokens (AfmCancelTokens): Keyword Args: _return_http_data_only (bool): response data without head status @@ -9207,7 +9677,7 @@ def cancel_workflow( async_req (bool): execute request asynchronously Returns: - {str: (str,)} + AfmCancelTokens If the method is called asynchronously, returns the request thread. """ @@ -9238,9 +9708,9 @@ def cancel_workflow( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['run_id'] = \ - run_id - return self.cancel_workflow_endpoint.call_with_http_info(**kwargs) + kwargs['afm_cancel_tokens'] = \ + afm_cancel_tokens + return self.cancel_flows_endpoint.call_with_http_info(**kwargs) def change_analysis( self, @@ -10378,6 +10848,92 @@ def compute_valid_objects( afm_valid_objects_query return self.compute_valid_objects_endpoint.call_with_http_info(**kwargs) + def computed_attribute_permissions( + self, + workspace_id, + computed_attribute_id, + **kwargs + ): + """(BETA) Get Computed Attribute Permissions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.computed_attribute_permissions(workspace_id, computed_attribute_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + computed_attribute_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: + ComputedAttributePermissions + 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['computed_attribute_id'] = \ + computed_attribute_id + return self.computed_attribute_permissions_endpoint.call_with_http_info(**kwargs) + def convert_geo_file( self, convert_geo_file_request, @@ -10572,6 +11128,7 @@ def create_image_export( 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 @@ -10814,24 +11371,24 @@ def create_raw_export( raw_export_request return self.create_raw_export_endpoint.call_with_http_info(**kwargs) - def create_slides_export( + def create_report_export( self, workspace_id, - slides_export_request, + report_export_request, **kwargs ): - """(EXPERIMENTAL) Create slides export request # noqa: E501 + """(EXPERIMENTAL) Create report export request # noqa: E501 - Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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 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 - >>> thread = api.create_slides_export(workspace_id, slides_export_request, async_req=True) + >>> thread = api.create_report_export(workspace_id, report_export_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - slides_export_request (SlidesExportRequest): + report_export_request (ReportExportRequest): Keyword Args: x_gdc_debug (bool): [optional] if omitted the server will use the default value of False @@ -10898,30 +11455,31 @@ def create_slides_export( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['slides_export_request'] = \ - slides_export_request - return self.create_slides_export_endpoint.call_with_http_info(**kwargs) + kwargs['report_export_request'] = \ + report_export_request + return self.create_report_export_endpoint.call_with_http_info(**kwargs) - def create_tabular_export( + def create_slides_export( self, workspace_id, - tabular_export_request, + slides_export_request, **kwargs ): - """Create tabular export request # noqa: E501 + """(EXPERIMENTAL) Create slides export request # noqa: E501 - An tabular 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 slides 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_tabular_export(workspace_id, tabular_export_request, async_req=True) + >>> thread = api.create_slides_export(workspace_id, slides_export_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): - tabular_export_request (TabularExportRequest): + slides_export_request (SlidesExportRequest): 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 @@ -10985,26 +11543,28 @@ def create_tabular_export( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['tabular_export_request'] = \ - tabular_export_request - return self.create_tabular_export_endpoint.call_with_http_info(**kwargs) + kwargs['slides_export_request'] = \ + slides_export_request + return self.create_slides_export_endpoint.call_with_http_info(**kwargs) - def created_by( + def create_tabular_export( self, workspace_id, + tabular_export_request, **kwargs ): - """Get Analytics Catalog CreatedBy Users # noqa: E501 + """Create tabular export request # noqa: E501 - Returns a list of Users who created any object for this workspace # noqa: E501 + An tabular 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.created_by(workspace_id, async_req=True) + >>> thread = api.create_tabular_export(workspace_id, tabular_export_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): + tabular_export_request (TabularExportRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -11039,7 +11599,7 @@ def created_by( async_req (bool): execute request asynchronously Returns: - AnalyticsCatalogCreatedBy + ExportResponse If the method is called asynchronously, returns the request thread. """ @@ -11070,7 +11630,92 @@ def created_by( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.created_by_endpoint.call_with_http_info(**kwargs) + kwargs['tabular_export_request'] = \ + tabular_export_request + return self.create_tabular_export_endpoint.call_with_http_info(**kwargs) + + def created_by( + self, + workspace_id, + **kwargs + ): + """Get Analytics Catalog CreatedBy Users # noqa: E501 + + Returns a list of Users who created any object for this workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.created_by(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: + AnalyticsCatalogCreatedBy + 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.created_by_endpoint.call_with_http_info(**kwargs) def custom_geo_collection_staging_upload( self, @@ -11496,27 +12141,26 @@ def delete_workspace_automations( workspace_automation_management_bulk_request return self.delete_workspace_automations_endpoint.call_with_http_info(**kwargs) - def explain_afm( + def execute_flow( self, workspace_id, - afm_execution, + flow_request, **kwargs ): - """AFM explain resource. # noqa: E501 + """(EXPERIMENTAL) Execute a flow # noqa: E501 - The resource provides static structures needed for investigation of a problem with given AFM. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.explain_afm(workspace_id, afm_execution, async_req=True) + >>> thread = api.execute_flow(workspace_id, flow_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - afm_execution (AfmExecution): + flow_request (FlowRequest): Keyword Args: - explain_type (str): Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build. [optional] _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 @@ -11549,7 +12193,7 @@ def explain_afm( async_req (bool): execute request asynchronously Returns: - None + FlowExecutionResponse If the method is called asynchronously, returns the request thread. """ @@ -11580,29 +12224,31 @@ def explain_afm( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['afm_execution'] = \ - afm_execution - return self.explain_afm_endpoint.call_with_http_info(**kwargs) + kwargs['flow_request'] = \ + flow_request + return self.execute_flow_endpoint.call_with_http_info(**kwargs) - def fact_permissions( + def explain_afm( self, workspace_id, - fact_id, + afm_execution, **kwargs ): - """Get Fact Permissions # noqa: E501 + """AFM explain resource. # noqa: E501 + The resource provides static structures needed for investigation of a problem with given AFM. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.fact_permissions(workspace_id, fact_id, async_req=True) + >>> thread = api.explain_afm(workspace_id, afm_execution, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - fact_id (str): + workspace_id (str): Workspace identifier + afm_execution (AfmExecution): Keyword Args: + explain_type (str): Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build. [optional] _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 @@ -11635,7 +12281,7 @@ def fact_permissions( async_req (bool): execute request asynchronously Returns: - FactPermissions + None If the method is called asynchronously, returns the request thread. """ @@ -11666,33 +12312,29 @@ def fact_permissions( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['fact_id'] = \ - fact_id - return self.fact_permissions_endpoint.call_with_http_info(**kwargs) + kwargs['afm_execution'] = \ + afm_execution + return self.explain_afm_endpoint.call_with_http_info(**kwargs) - def forecast( + def fact_permissions( self, workspace_id, - result_id, - forecast_request, + fact_id, **kwargs ): - """Smart functions - Forecast # noqa: E501 + """Get Fact Permissions # noqa: E501 - Computes forecasted data points from the provided execution result and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.forecast(workspace_id, result_id, forecast_request, async_req=True) + >>> thread = api.fact_permissions(workspace_id, fact_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): Workspace identifier - result_id (str): Input result ID to be used in the computation - forecast_request (ForecastRequest): + workspace_id (str): + fact_id (str): Keyword Args: - skip_cache (bool): Ignore all caches during execution of current request.. [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 @@ -11725,7 +12367,7 @@ def forecast( async_req (bool): execute request asynchronously Returns: - SmartFunctionResponse + FactPermissions If the method is called asynchronously, returns the request thread. """ @@ -11756,34 +12398,33 @@ def forecast( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['result_id'] = \ - result_id - kwargs['forecast_request'] = \ - forecast_request - return self.forecast_endpoint.call_with_http_info(**kwargs) + kwargs['fact_id'] = \ + fact_id + return self.fact_permissions_endpoint.call_with_http_info(**kwargs) - def forecast_result( + def forecast( self, workspace_id, result_id, + forecast_request, **kwargs ): - """Smart functions - Forecast Result # noqa: E501 + """Smart functions - Forecast # noqa: E501 - Gets forecast result. # noqa: E501 + Computes forecasted data points from the provided execution result and parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.forecast_result(workspace_id, result_id, async_req=True) + >>> thread = api.forecast(workspace_id, result_id, forecast_request, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - result_id (str): Result ID + result_id (str): Input result ID to be used in the computation + forecast_request (ForecastRequest): Keyword Args: - offset (int): [optional] - limit (int): [optional] + skip_cache (bool): Ignore all caches during execution of current request.. [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 @@ -11816,7 +12457,7 @@ def forecast_result( async_req (bool): execute request asynchronously Returns: - ForecastResult + SmartFunctionResponse If the method is called asynchronously, returns the request thread. """ @@ -11849,27 +12490,32 @@ def forecast_result( workspace_id kwargs['result_id'] = \ result_id - return self.forecast_result_endpoint.call_with_http_info(**kwargs) + kwargs['forecast_request'] = \ + forecast_request + return self.forecast_endpoint.call_with_http_info(**kwargs) - def generate_dashboard_summary( + def forecast_result( self, workspace_id, - workflow_dashboard_summary_request_dto, + result_id, **kwargs ): - """generate_dashboard_summary # noqa: E501 + """Smart functions - Forecast Result # noqa: E501 + Gets forecast result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.generate_dashboard_summary(workspace_id, workflow_dashboard_summary_request_dto, async_req=True) + >>> thread = api.forecast_result(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - workflow_dashboard_summary_request_dto (WorkflowDashboardSummaryRequestDto): + result_id (str): Result ID Keyword Args: + offset (int): [optional] + limit (int): [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 @@ -11902,7 +12548,7 @@ def generate_dashboard_summary( async_req (bool): execute request asynchronously Returns: - WorkflowDashboardSummaryResponseDto + ForecastResult If the method is called asynchronously, returns the request thread. """ @@ -11933,9 +12579,9 @@ def generate_dashboard_summary( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['workflow_dashboard_summary_request_dto'] = \ - workflow_dashboard_summary_request_dto - return self.generate_dashboard_summary_endpoint.call_with_http_info(**kwargs) + kwargs['result_id'] = \ + result_id + return self.forecast_result_endpoint.call_with_http_info(**kwargs) def generate_description( self, @@ -13139,7 +13785,7 @@ def get_raw_export( export_id return self.get_raw_export_endpoint.call_with_http_info(**kwargs) - def get_slides_export( + def get_report_export( self, workspace_id, export_id, @@ -13151,7 +13797,7 @@ def get_slides_export( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_slides_export(workspace_id, export_id, async_req=True) + >>> thread = api.get_report_export(workspace_id, export_id, async_req=True) >>> result = thread.get() Args: @@ -13224,9 +13870,9 @@ def get_slides_export( workspace_id kwargs['export_id'] = \ export_id - return self.get_slides_export_endpoint.call_with_http_info(**kwargs) + return self.get_report_export_endpoint.call_with_http_info(**kwargs) - def get_slides_export_metadata( + def get_report_export_metadata( self, workspace_id, export_id, @@ -13234,11 +13880,11 @@ def get_slides_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/slides endpoint. The metadata structure is not verified. # 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 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_slides_export_metadata(workspace_id, export_id, async_req=True) + >>> thread = api.get_report_export_metadata(workspace_id, export_id, async_req=True) >>> result = thread.get() Args: @@ -13311,21 +13957,21 @@ def get_slides_export_metadata( workspace_id kwargs['export_id'] = \ export_id - return self.get_slides_export_metadata_endpoint.call_with_http_info(**kwargs) + return self.get_report_export_metadata_endpoint.call_with_http_info(**kwargs) - def get_tabular_export( + def get_slides_export( self, workspace_id, export_id, **kwargs ): - """Retrieve exported files # noqa: E501 + """(EXPERIMENTAL) Retrieve exported files # noqa: E501 - After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 + 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_tabular_export(workspace_id, export_id, async_req=True) + >>> thread = api.get_slides_export(workspace_id, export_id, async_req=True) >>> result = thread.get() Args: @@ -13398,24 +14044,26 @@ def get_tabular_export( workspace_id kwargs['export_id'] = \ export_id - return self.get_tabular_export_endpoint.call_with_http_info(**kwargs) + return self.get_slides_export_endpoint.call_with_http_info(**kwargs) - def get_translation_tags( + def get_slides_export_metadata( self, workspace_id, + export_id, **kwargs ): - """Get translation tags. # noqa: E501 + """(EXPERIMENTAL) Retrieve metadata context # noqa: E501 - Provides a list of effective translation tags. # 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/slides 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_translation_tags(workspace_id, async_req=True) + >>> thread = api.get_slides_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 @@ -13450,7 +14098,7 @@ def get_translation_tags( async_req (bool): execute request asynchronously Returns: - [str] + None If the method is called asynchronously, returns the request thread. """ @@ -13481,25 +14129,28 @@ def get_translation_tags( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_translation_tags_endpoint.call_with_http_info(**kwargs) + kwargs['export_id'] = \ + export_id + return self.get_slides_export_metadata_endpoint.call_with_http_info(**kwargs) - def get_workflow_status( + def get_tabular_export( self, workspace_id, - run_id, + export_id, **kwargs ): - """get_workflow_status # noqa: E501 + """Retrieve exported files # noqa: E501 + After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_workflow_status(workspace_id, run_id, async_req=True) + >>> thread = api.get_tabular_export(workspace_id, export_id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): Workspace identifier - run_id (str): + workspace_id (str): + export_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13534,7 +14185,7 @@ def get_workflow_status( async_req (bool): execute request asynchronously Returns: - WorkflowStatusResponseDto + file_type If the method is called asynchronously, returns the request thread. """ @@ -13565,28 +14216,26 @@ def get_workflow_status( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['run_id'] = \ - run_id - return self.get_workflow_status_endpoint.call_with_http_info(**kwargs) + kwargs['export_id'] = \ + export_id + return self.get_tabular_export_endpoint.call_with_http_info(**kwargs) - def import_csv( + def get_translation_tags( self, - data_source_id, - import_csv_request, + workspace_id, **kwargs ): - """Import CSV # noqa: E501 + """Get translation tags. # noqa: E501 - Import the CSV files at the given locations in the staging area to the final location. # noqa: E501 + Provides a list of effective translation tags. # 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_csv(data_source_id, import_csv_request, async_req=True) + >>> thread = api.get_translation_tags(workspace_id, async_req=True) >>> result = thread.get() Args: - data_source_id (str): - import_csv_request (ImportCsvRequest): + workspace_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -13621,7 +14270,7 @@ def import_csv( async_req (bool): execute request asynchronously Returns: - [ImportCsvResponse] + [str] If the method is called asynchronously, returns the request thread. """ @@ -13650,21 +14299,106 @@ def import_csv( '_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_csv_request'] = \ - import_csv_request - return self.import_csv_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_translation_tags_endpoint.call_with_http_info(**kwargs) - def import_custom_geo_collection( + def import_csv( self, - collection_id, - import_geo_collection_request, + data_source_id, + import_csv_request, **kwargs ): - """Import custom geo collection # noqa: E501 + """Import CSV # noqa: E501 - Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns). # noqa: E501 + Import the CSV files at the given locations in the staging area to the final location. # 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_csv(data_source_id, import_csv_request, async_req=True) + >>> result = thread.get() + + Args: + data_source_id (str): + import_csv_request (ImportCsvRequest): + + 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: + [ImportCsvResponse] + 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_csv_request'] = \ + import_csv_request + return self.import_csv_endpoint.call_with_http_info(**kwargs) + + def import_custom_geo_collection( + self, + collection_id, + import_geo_collection_request, + **kwargs + ): + """Import custom geo collection # noqa: E501 + + Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns). # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -14255,6 +14989,89 @@ def list_files( data_source_id return self.list_files_endpoint.call_with_http_info(**kwargs) + def list_flow_operations( + self, + workspace_id, + **kwargs + ): + """(EXPERIMENTAL) List the operations of flows # noqa: E501 + + Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.list_flow_operations(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + + 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: + FlowOperations + 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.list_flow_operations_endpoint.call_with_http_info(**kwargs) + def list_llm_provider_models( self, list_llm_provider_models_request, @@ -14681,6 +15498,96 @@ def manage_attribute_permissions( manage_attribute_permissions_request_inner return self.manage_attribute_permissions_endpoint.call_with_http_info(**kwargs) + def manage_computed_attribute_permissions( + self, + workspace_id, + computed_attribute_id, + manage_computed_attribute_permissions_request_inner, + **kwargs + ): + """(BETA) Manage Permissions for a Computed Attribute # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + computed_attribute_id (str): + manage_computed_attribute_permissions_request_inner ([ManageComputedAttributePermissionsRequestInner]): + + 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['computed_attribute_id'] = \ + computed_attribute_id + kwargs['manage_computed_attribute_permissions_request_inner'] = \ + manage_computed_attribute_permissions_request_inner + return self.manage_computed_attribute_permissions_endpoint.call_with_http_info(**kwargs) + def manage_dashboard_permissions( self, workspace_id, @@ -15211,24 +16118,25 @@ def manage_organization_permissions( organization_permission_assignment return self.manage_organization_permissions_endpoint.call_with_http_info(**kwargs) - def manage_workspace_permissions( + def manage_visualization_permissions( self, workspace_id, - workspace_permission_assignment, + visualization_object_id, + manage_visualization_permissions_request_inner, **kwargs ): - """Manage Permissions for a Workspace # noqa: E501 + """(BETA) Manage Permissions for a Visualization # noqa: E501 - Manage Permissions for a Workspace and its Workspace Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.manage_workspace_permissions(workspace_id, workspace_permission_assignment, async_req=True) + >>> thread = api.manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner, async_req=True) >>> result = thread.get() Args: workspace_id (str): - workspace_permission_assignment ([WorkspacePermissionAssignment]): + visualization_object_id (str): + manage_visualization_permissions_request_inner ([ManageVisualizationPermissionsRequestInner]): Keyword Args: _return_http_data_only (bool): response data without head status @@ -15294,9 +16202,98 @@ def manage_workspace_permissions( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['workspace_permission_assignment'] = \ - workspace_permission_assignment - return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) + kwargs['visualization_object_id'] = \ + visualization_object_id + kwargs['manage_visualization_permissions_request_inner'] = \ + manage_visualization_permissions_request_inner + return self.manage_visualization_permissions_endpoint.call_with_http_info(**kwargs) + + def manage_workspace_permissions( + self, + workspace_id, + workspace_permission_assignment, + **kwargs + ): + """Manage Permissions for a Workspace # noqa: E501 + + Manage Permissions for a Workspace and its Workspace Hierarchy # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.manage_workspace_permissions(workspace_id, workspace_permission_assignment, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + workspace_permission_assignment ([WorkspacePermissionAssignment]): + + 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['workspace_permission_assignment'] = \ + workspace_permission_assignment + return self.manage_workspace_permissions_endpoint.call_with_http_info(**kwargs) def mark_as_read_notification( self, @@ -16140,6 +17137,89 @@ def pause_workspace_automations( workspace_automation_management_bulk_request return self.pause_workspace_automations_endpoint.call_with_http_info(**kwargs) + def process_invitation( + self, + invitation, + **kwargs + ): + """Invite User # noqa: E501 + + Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_invitation(invitation, async_req=True) + >>> result = thread.get() + + Args: + invitation (Invitation): + + 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['invitation'] = \ + invitation + return self.process_invitation_endpoint.call_with_http_info(**kwargs) + def read_csv_file_manifests( self, data_source_id, @@ -16604,7 +17684,167 @@ def resolve_all_entitlements( async_req (bool): execute request asynchronously Returns: - [ApiEntitlement] + [ApiEntitlement] + 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.resolve_all_entitlements_endpoint.call_with_http_info(**kwargs) + + def resolve_all_settings_without_workspace( + self, + **kwargs + ): + """Values for all settings without workspace. # noqa: E501 + + Resolves values for all settings without workspace by current user, organization, or default 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.resolve_all_settings_without_workspace(async_req=True) + >>> result = thread.get() + + + Keyword Args: + exclude_user_settings (bool): If true, user-level settings are excluded from resolution.. [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: + [ResolvedSetting] + 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.resolve_all_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + + def resolve_llm_endpoints( + self, + workspace_id, + **kwargs + ): + """Get Active LLM Endpoints for this workspace (Removed) # noqa: E501 + + Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders 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.resolve_llm_endpoints(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): Workspace identifier + + 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. """ @@ -16633,24 +17873,28 @@ def resolve_all_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_entitlements_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def resolve_all_settings_without_workspace( + def resolve_requested_entitlements( self, + entitlements_request, **kwargs ): - """Values for all settings without workspace. # noqa: E501 + """Values for requested public entitlements. # noqa: E501 - Resolves values for all settings without workspace by current user, organization, or default settings. # noqa: E501 + Resolves values for requested entitlements in the organization. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_all_settings_without_workspace(async_req=True) + >>> thread = api.resolve_requested_entitlements(entitlements_request, async_req=True) >>> result = thread.get() + Args: + entitlements_request (EntitlementsRequest): Keyword Args: - exclude_user_settings (bool): If true, user-level settings are excluded from resolution.. [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 @@ -16683,7 +17927,7 @@ def resolve_all_settings_without_workspace( async_req (bool): execute request asynchronously Returns: - [ResolvedSetting] + [ApiEntitlement] If the method is called asynchronously, returns the request thread. """ @@ -16712,26 +17956,29 @@ def resolve_all_settings_without_workspace( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.resolve_all_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + kwargs['entitlements_request'] = \ + entitlements_request + return self.resolve_requested_entitlements_endpoint.call_with_http_info(**kwargs) - def resolve_llm_endpoints( + def resolve_settings_without_workspace( self, - workspace_id, + resolve_settings_request, **kwargs ): - """Get Active LLM Endpoints for this workspace (Removed) # noqa: E501 + """Values for selected settings without workspace. # noqa: E501 - Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders instead. Always returns 410 Gone. # noqa: E501 + Resolves values for selected settings without workspace by current user, organization, or default 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.resolve_llm_endpoints(workspace_id, async_req=True) + >>> thread = api.resolve_settings_without_workspace(resolve_settings_request, async_req=True) >>> result = thread.get() Args: - workspace_id (str): Workspace identifier + resolve_settings_request (ResolveSettingsRequest): Keyword Args: + exclude_user_settings (bool): If true, user-level settings are excluded from resolution.. [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 @@ -16764,7 +18011,7 @@ def resolve_llm_endpoints( async_req (bool): execute request asynchronously Returns: - None + [ResolvedSetting] If the method is called asynchronously, returns the request thread. """ @@ -16793,26 +18040,28 @@ def resolve_llm_endpoints( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) + kwargs['resolve_settings_request'] = \ + resolve_settings_request + return self.resolve_settings_without_workspace_endpoint.call_with_http_info(**kwargs) - def resolve_llm_providers( + def retrieve_execution_metadata( self, workspace_id, + result_id, **kwargs ): - """Get Active LLM configuration for this workspace # noqa: E501 + """Get a single execution result's metadata. # noqa: E501 - Resolves the active LLM provider configuration for the given workspace. # noqa: E501 + The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_llm_providers(workspace_id, async_req=True) + >>> thread = api.retrieve_execution_metadata(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier + result_id (str): Result ID Keyword Args: _return_http_data_only (bool): response data without head status @@ -16847,7 +18096,7 @@ def resolve_llm_providers( async_req (bool): execute request asynchronously Returns: - ResolvedLlms + ResultCacheMetadata If the method is called asynchronously, returns the request thread. """ @@ -16878,26 +18127,34 @@ def resolve_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.resolve_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['result_id'] = \ + result_id + return self.retrieve_execution_metadata_endpoint.call_with_http_info(**kwargs) - def resolve_requested_entitlements( + def retrieve_flow_result_binary( self, - entitlements_request, + workspace_id, + result_id, **kwargs ): - """Values for requested public entitlements. # noqa: E501 + """(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format # noqa: E501 - Resolves values for requested entitlements in the organization. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_requested_entitlements(entitlements_request, async_req=True) + >>> thread = api.retrieve_flow_result_binary(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: - entitlements_request (EntitlementsRequest): + workspace_id (str): Workspace identifier + result_id (str): Result ID Keyword Args: + row_offset (int): Index of the first row to return. The default is 0.. [optional] + row_limit (int): Maximum number of rows to return. The default is all remaining rows.. [optional] + column_offset (int): Index of the first column to return. The default is 0.. [optional] + column_limit (int): Maximum number of columns to return. The default is all remaining columns.. [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 @@ -16930,7 +18187,7 @@ def resolve_requested_entitlements( async_req (bool): execute request asynchronously Returns: - [ApiEntitlement] + file_type If the method is called asynchronously, returns the request thread. """ @@ -16959,29 +18216,32 @@ def resolve_requested_entitlements( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['entitlements_request'] = \ - entitlements_request - return self.resolve_requested_entitlements_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + return self.retrieve_flow_result_binary_endpoint.call_with_http_info(**kwargs) - def resolve_settings_without_workspace( + def retrieve_flow_result_metadata( self, - resolve_settings_request, + workspace_id, + result_id, **kwargs ): - """Values for selected settings without workspace. # noqa: E501 + """(EXPERIMENTAL) Get the metadata of a flow result # noqa: E501 - Resolves values for selected settings without workspace by current user, organization, or default settings. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.resolve_settings_without_workspace(resolve_settings_request, async_req=True) + >>> thread = api.retrieve_flow_result_metadata(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: - resolve_settings_request (ResolveSettingsRequest): + workspace_id (str): Workspace identifier + result_id (str): Result ID Keyword Args: - exclude_user_settings (bool): If true, user-level settings are excluded from resolution.. [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 @@ -17014,7 +18274,7 @@ def resolve_settings_without_workspace( async_req (bool): execute request asynchronously Returns: - [ResolvedSetting] + FlowResultMetadata If the method is called asynchronously, returns the request thread. """ @@ -17043,23 +18303,25 @@ def resolve_settings_without_workspace( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['resolve_settings_request'] = \ - resolve_settings_request - return self.resolve_settings_without_workspace_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + return self.retrieve_flow_result_metadata_endpoint.call_with_http_info(**kwargs) - def retrieve_execution_metadata( + def retrieve_flow_result_table( self, workspace_id, result_id, **kwargs ): - """Get a single execution result's metadata. # noqa: E501 + """(EXPERIMENTAL) Get a page of a flow result # noqa: E501 - The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.retrieve_execution_metadata(workspace_id, result_id, async_req=True) + >>> thread = api.retrieve_flow_result_table(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: @@ -17067,6 +18329,10 @@ def retrieve_execution_metadata( result_id (str): Result ID Keyword Args: + row_offset (int): Index of the first row to return. The default is 0.. [optional] + row_limit (int): Maximum number of rows to return. The default is all remaining rows.. [optional] + column_offset (int): Index of the first column to return. The default is 0.. [optional] + column_limit (int): Maximum number of columns to return. The default is all remaining columns.. [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 @@ -17099,7 +18365,7 @@ def retrieve_execution_metadata( async_req (bool): execute request asynchronously Returns: - ResultCacheMetadata + FlowTableResult If the method is called asynchronously, returns the request thread. """ @@ -17132,7 +18398,7 @@ def retrieve_execution_metadata( workspace_id kwargs['result_id'] = \ result_id - return self.retrieve_execution_metadata_endpoint.call_with_http_info(**kwargs) + return self.retrieve_flow_result_table_endpoint.call_with_http_info(**kwargs) def retrieve_result( self, @@ -17580,9 +18846,9 @@ def scan_statistics( table_statistics_request, **kwargs ): - """(BETA) Collect physical table and column statistics from a StarRocks data source # noqa: E501 + """(BETA) Collect physical table and column statistics from a data source # noqa: E501 - (BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values. # noqa: E501 + (BETA) Reads the statistics the database already maintains in its own catalog, without scanning any data. Supported for StarRocks (both internal catalog for native/PIPE tables and external catalog for Iceberg tables), BigQuery, PostgreSQL, Redshift, Snowflake, Vertica, SQL Server, Azure SQL, MySQL, MariaDB and SingleStore. Statistics include row counts and data sizes, and, where the database exposes them, NDV (number of distinct values), null counts and min/max values. Returns an empty result for a data source whose database exposes no such catalog. Also returns an empty result for a data source that sets disableStatistics. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -18001,6 +19267,84 @@ def switch_active_identity_provider( switch_identity_provider_request return self.switch_active_identity_provider_endpoint.call_with_http_info(**kwargs) + def sync_metadata( + self, + **kwargs + ): + """Trigger metadata synchronization # noqa: E501 + + Enqueues an organization-scoped metadata resync, fanning out the organization's current metadata to GenAI, GW Forge, and Automations. Requires organization MANAGE permission. Requests are deduplicated while a resync session is pending for the organization. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_metadata(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_metadata_endpoint.call_with_http_info(**kwargs) + def tags( self, workspace_id, @@ -19670,6 +21014,92 @@ def validate_llm_endpoint_by_id( llm_endpoint_id return self.validate_llm_endpoint_by_id_endpoint.call_with_http_info(**kwargs) + def visualization_permissions( + self, + workspace_id, + visualization_object_id, + **kwargs + ): + """(BETA) Get Visualization Permissions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.visualization_permissions(workspace_id, visualization_object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + visualization_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: + VisualizationPermissions + 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['visualization_object_id'] = \ + visualization_object_id + return self.visualization_permissions_endpoint.call_with_http_info(**kwargs) + def workspace_resolve_all_settings( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/ai_agents_api.py b/gooddata-api-client/gooddata_api_client/api/agents_api.py similarity index 99% rename from gooddata-api-client/gooddata_api_client/api/ai_agents_api.py rename to gooddata-api-client/gooddata_api_client/api/agents_api.py index 77533f1c5..15eaba296 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_agents_api.py +++ b/gooddata-api-client/gooddata_api_client/api/agents_api.py @@ -28,7 +28,7 @@ from gooddata_api_client.model.json_api_agent_patch_document import JsonApiAgentPatchDocument -class AIAgentsApi(object): +class AgentsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py index 1b7576b5a..e7ca337c1 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_api.py @@ -25,18 +25,14 @@ from gooddata_api_client.model.add_database_data_source_request import AddDatabaseDataSourceRequest from gooddata_api_client.model.add_database_data_source_response import AddDatabaseDataSourceResponse from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest -from gooddata_api_client.model.create_pipe_table_request import CreatePipeTableRequest from gooddata_api_client.model.get_ai_lake_operation200_response import GetAiLakeOperation200Response from gooddata_api_client.model.get_service_status_response import GetServiceStatusResponse from gooddata_api_client.model.json_api_document_database_instance import JsonApiDocumentDatabaseInstance -from gooddata_api_client.model.json_api_document_pipe_table import JsonApiDocumentPipeTable from gooddata_api_client.model.json_api_list_document_data_source_info import JsonApiListDocumentDataSourceInfo from gooddata_api_client.model.json_api_list_document_database_instance import JsonApiListDocumentDatabaseInstance from gooddata_api_client.model.json_api_list_document_object_storage_info import JsonApiListDocumentObjectStorageInfo -from gooddata_api_client.model.json_api_list_document_pipe_table_summary import JsonApiListDocumentPipeTableSummary from gooddata_api_client.model.json_api_list_document_service_info import JsonApiListDocumentServiceInfo from gooddata_api_client.model.provision_database_instance_request import ProvisionDatabaseInstanceRequest -from gooddata_api_client.model.refresh_partition_request import RefreshPartitionRequest from gooddata_api_client.model.remove_database_data_source_response import RemoveDatabaseDataSourceResponse from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest from gooddata_api_client.model.update_database_data_source_request import UpdateDatabaseDataSourceRequest @@ -169,123 +165,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_ai_lake_pipe_table_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables', - 'operation_id': 'create_ai_lake_pipe_table', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'instance_id', - 'create_pipe_table_request', - 'operation_id', - ], - 'required': [ - 'instance_id', - 'create_pipe_table_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'instance_id': - (str,), - 'create_pipe_table_request': - (CreatePipeTableRequest,), - 'operation_id': - (str,), - }, - 'attribute_map': { - 'instance_id': 'instanceId', - 'operation_id': 'operation-id', - }, - 'location_map': { - 'instance_id': 'path', - 'create_pipe_table_request': 'body', - 'operation_id': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.delete_ai_lake_pipe_table_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}', - 'operation_id': 'delete_ai_lake_pipe_table', - 'http_method': 'DELETE', - 'servers': None, - }, - params_map={ - 'all': [ - 'instance_id', - 'table_name', - 'operation_id', - ], - 'required': [ - 'instance_id', - 'table_name', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'instance_id': - (str,), - 'table_name': - (str,), - 'operation_id': - (str,), - }, - 'attribute_map': { - 'instance_id': 'instanceId', - 'table_name': 'tableName', - 'operation_id': 'operation-id', - }, - 'location_map': { - 'instance_id': 'path', - 'table_name': 'path', - 'operation_id': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [], - }, - api_client=api_client - ) self.deprovision_ai_lake_database_instance_endpoint = _Endpoint( settings={ 'response_type': None, @@ -298,6 +177,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'instance_id', + 'cascade', 'operation_id', ], 'required': [ @@ -318,15 +198,19 @@ def __init__(self, api_client=None): 'openapi_types': { 'instance_id': (str,), + 'cascade': + (bool,), 'operation_id': (str,), }, 'attribute_map': { 'instance_id': 'instanceId', + 'cascade': 'cascade', 'operation_id': 'operation-id', }, 'location_map': { 'instance_id': 'path', + 'cascade': 'query', 'operation_id': 'header', }, 'collection_format_map': { @@ -436,61 +320,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_ai_lake_pipe_table_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiDocumentPipeTable,), - 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}', - 'operation_id': 'get_ai_lake_pipe_table', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'instance_id', - 'table_name', - ], - 'required': [ - 'instance_id', - 'table_name', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'instance_id': - (str,), - 'table_name': - (str,), - }, - 'attribute_map': { - 'instance_id': 'instanceId', - 'table_name': 'tableName', - }, - 'location_map': { - 'instance_id': 'path', - 'table_name': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.get_ai_lake_service_status_endpoint = _Endpoint( settings={ 'response_type': (GetServiceStatusResponse,), @@ -766,86 +595,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.list_ai_lake_pipe_tables_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiListDocumentPipeTableSummary,), - 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables', - 'operation_id': 'list_ai_lake_pipe_tables', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'instance_id', - 'page', - 'size', - 'meta_include', - ], - 'required': [ - 'instance_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'page', - 'size', - 'meta_include', - ] - }, - root_map={ - 'validations': { - ('page',): { - - 'inclusive_minimum': 0, - }, - ('size',): { - - 'inclusive_maximum': 500, - 'inclusive_minimum': 1, - }, - ('meta_include',): { - - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'instance_id': - (str,), - 'page': - (int,), - 'size': - (int,), - 'meta_include': - ([str],), - }, - 'attribute_map': { - 'instance_id': 'instanceId', - 'page': 'page', - 'size': 'size', - 'meta_include': 'metaInclude', - }, - 'location_map': { - 'instance_id': 'path', - 'page': 'query', - 'size': 'query', - 'meta_include': 'query', - }, - 'collection_format_map': { - 'meta_include': 'multi', - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.list_ai_lake_services_endpoint = _Endpoint( settings={ 'response_type': (JsonApiListDocumentServiceInfo,), @@ -972,71 +721,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.refresh_ai_lake_pipe_table_partition_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh', - 'operation_id': 'refresh_ai_lake_pipe_table_partition', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'instance_id', - 'table_name', - 'refresh_partition_request', - 'operation_id', - ], - 'required': [ - 'instance_id', - 'table_name', - 'refresh_partition_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'instance_id': - (str,), - 'table_name': - (str,), - 'refresh_partition_request': - (RefreshPartitionRequest,), - 'operation_id': - (str,), - }, - 'attribute_map': { - 'instance_id': 'instanceId', - 'table_name': 'tableName', - 'operation_id': 'operation-id', - }, - 'location_map': { - 'instance_id': 'path', - 'table_name': 'path', - 'refresh_partition_request': 'body', - 'operation_id': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) self.remove_ai_lake_database_data_source_endpoint = _Endpoint( settings={ 'response_type': (RemoveDatabaseDataSourceResponse,), @@ -1214,202 +898,26 @@ def __init__(self, api_client=None): api_client=api_client ) - def add_ai_lake_database_data_source( - self, - instance_id, - add_database_data_source_request, - **kwargs - ): - """(BETA) Add a data source to an AILake Database instance # noqa: E501 - - (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.add_ai_lake_database_data_source(instance_id, add_database_data_source_request, async_req=True) - >>> result = thread.get() - - Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - add_database_data_source_request (AddDatabaseDataSourceRequest): - - 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: - AddDatabaseDataSourceResponse - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['add_database_data_source_request'] = \ - add_database_data_source_request - return self.add_ai_lake_database_data_source_endpoint.call_with_http_info(**kwargs) - - def analyze_statistics( - self, - instance_id, - analyze_statistics_request, - **kwargs - ): - """(BETA) Run ANALYZE TABLE for tables in a database instance # noqa: E501 - - (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. # 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_statistics(instance_id, analyze_statistics_request, async_req=True) - >>> result = thread.get() - - Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - analyze_statistics_request (AnalyzeStatisticsRequest): - - Keyword Args: - operation_id (str): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['analyze_statistics_request'] = \ - analyze_statistics_request - return self.analyze_statistics_endpoint.call_with_http_info(**kwargs) - - def create_ai_lake_pipe_table( + def add_ai_lake_database_data_source( self, instance_id, - create_pipe_table_request, + add_database_data_source_request, **kwargs ): - """(BETA) Create a new AI Lake pipe table # noqa: E501 + """(BETA) Add a data source to an AILake Database instance # noqa: E501 - (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress. # noqa: E501 + (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source. # 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_ai_lake_pipe_table(instance_id, create_pipe_table_request, async_req=True) + >>> thread = api.add_ai_lake_database_data_source(instance_id, add_database_data_source_request, async_req=True) >>> result = thread.get() Args: instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - create_pipe_table_request (CreatePipeTableRequest): + add_database_data_source_request (AddDatabaseDataSourceRequest): Keyword Args: - operation_id (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -1442,7 +950,7 @@ def create_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - None + AddDatabaseDataSourceResponse If the method is called asynchronously, returns the request thread. """ @@ -1473,28 +981,28 @@ def create_ai_lake_pipe_table( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['instance_id'] = \ instance_id - kwargs['create_pipe_table_request'] = \ - create_pipe_table_request - return self.create_ai_lake_pipe_table_endpoint.call_with_http_info(**kwargs) + kwargs['add_database_data_source_request'] = \ + add_database_data_source_request + return self.add_ai_lake_database_data_source_endpoint.call_with_http_info(**kwargs) - def delete_ai_lake_pipe_table( + def analyze_statistics( self, instance_id, - table_name, + analyze_statistics_request, **kwargs ): - """(BETA) Delete an AI Lake pipe table # noqa: E501 + """(BETA) Run ANALYZE TABLE for tables in a database instance # noqa: E501 - (BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress. # noqa: E501 + (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. # 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_ai_lake_pipe_table(instance_id, table_name, async_req=True) + >>> thread = api.analyze_statistics(instance_id, analyze_statistics_request, async_req=True) >>> result = thread.get() Args: instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - table_name (str): Pipe table name. + analyze_statistics_request (AnalyzeStatisticsRequest): Keyword Args: operation_id (str): [optional] @@ -1561,9 +1069,9 @@ def delete_ai_lake_pipe_table( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['instance_id'] = \ instance_id - kwargs['table_name'] = \ - table_name - return self.delete_ai_lake_pipe_table_endpoint.call_with_http_info(**kwargs) + kwargs['analyze_statistics_request'] = \ + analyze_statistics_request + return self.analyze_statistics_endpoint.call_with_http_info(**kwargs) def deprovision_ai_lake_database_instance( self, @@ -1572,7 +1080,7 @@ def deprovision_ai_lake_database_instance( ): """(BETA) Delete an existing AILake Database instance # noqa: E501 - (BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress. # noqa: E501 + (BETA) Deletes an existing database in the organization's AI Lake. A database that still contains tables is not deleted, unless cascade is set. With cascade, every table in the database is dropped first, which cannot be undone. Returns an operation-id in the operation-id header the client can use to poll for the progress. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1583,6 +1091,7 @@ def deprovision_ai_lake_database_instance( instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. Keyword Args: + cascade (bool): Drop every table in the database before the database itself.. [optional] operation_id (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1815,93 +1324,6 @@ def get_ai_lake_operation( operation_id return self.get_ai_lake_operation_endpoint.call_with_http_info(**kwargs) - def get_ai_lake_pipe_table( - self, - instance_id, - table_name, - **kwargs - ): - """(BETA) Get an AI Lake pipe table # noqa: E501 - - (BETA) Returns full details of the specified pipe table. # 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_ai_lake_pipe_table(instance_id, table_name, async_req=True) - >>> result = thread.get() - - Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - table_name (str): Pipe table name. - - 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: - JsonApiDocumentPipeTable - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['table_name'] = \ - table_name - return self.get_ai_lake_pipe_table_endpoint.call_with_http_info(**kwargs) - def get_ai_lake_service_status( self, service_id, @@ -2158,7 +1580,7 @@ def list_ai_lake_object_storages( ): """(BETA) List registered AI Lake ObjectStorages # noqa: E501 - (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. # noqa: E501 + (BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2233,92 +1655,6 @@ def list_ai_lake_object_storages( kwargs['_request_auths'] = kwargs.get('_request_auths', None) return self.list_ai_lake_object_storages_endpoint.call_with_http_info(**kwargs) - def list_ai_lake_pipe_tables( - self, - instance_id, - **kwargs - ): - """(BETA) List AI Lake pipe tables # noqa: E501 - - (BETA) Lists active pipe tables in the given AI Lake database instance. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.list_ai_lake_pipe_tables(instance_id, async_req=True) - >>> result = thread.get() - - Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - - Keyword Args: - page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 - size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 - meta_include ([str]): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _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: - JsonApiListDocumentPipeTableSummary - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - return self.list_ai_lake_pipe_tables_endpoint.call_with_http_info(**kwargs) - def list_ai_lake_services( self, **kwargs @@ -2484,98 +1820,6 @@ def provision_ai_lake_database_instance( provision_database_instance_request return self.provision_ai_lake_database_instance_endpoint.call_with_http_info(**kwargs) - def refresh_ai_lake_pipe_table_partition( - self, - instance_id, - table_name, - refresh_partition_request, - **kwargs - ): - """(BETA) Refresh a pipe table partition # noqa: E501 - - (BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, async_req=True) - >>> result = thread.get() - - Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - table_name (str): Pipe table name. - refresh_partition_request (RefreshPartitionRequest): - - Keyword Args: - operation_id (str): [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['table_name'] = \ - table_name - kwargs['refresh_partition_request'] = \ - refresh_partition_request - return self.refresh_ai_lake_pipe_table_partition_endpoint.call_with_http_info(**kwargs) - def remove_ai_lake_database_data_source( self, instance_id, diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py b/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py index 2ca96a877..791228f40 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py +++ b/gooddata-api-client/gooddata_api_client/api/ai_lake_databases_api.py @@ -24,6 +24,7 @@ ) from gooddata_api_client.model.add_database_data_source_request import AddDatabaseDataSourceRequest from gooddata_api_client.model.add_database_data_source_response import AddDatabaseDataSourceResponse +from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest from gooddata_api_client.model.json_api_document_database_instance import JsonApiDocumentDatabaseInstance from gooddata_api_client.model.json_api_list_document_data_source_info import JsonApiListDocumentDataSourceInfo from gooddata_api_client.model.json_api_list_document_database_instance import JsonApiListDocumentDatabaseInstance @@ -101,6 +102,65 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.analyze_statistics_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics', + 'operation_id': 'analyze_statistics', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'instance_id', + 'analyze_statistics_request', + 'operation_id', + ], + 'required': [ + 'instance_id', + 'analyze_statistics_request', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'instance_id': + (str,), + 'analyze_statistics_request': + (AnalyzeStatisticsRequest,), + 'operation_id': + (str,), + }, + 'attribute_map': { + 'instance_id': 'instanceId', + 'operation_id': 'operation-id', + }, + 'location_map': { + 'instance_id': 'path', + 'analyze_statistics_request': 'body', + 'operation_id': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.deprovision_ai_lake_database_instance_endpoint = _Endpoint( settings={ 'response_type': None, @@ -113,6 +173,7 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'instance_id', + 'cascade', 'operation_id', ], 'required': [ @@ -133,15 +194,19 @@ def __init__(self, api_client=None): 'openapi_types': { 'instance_id': (str,), + 'cascade': + (bool,), 'operation_id': (str,), }, 'attribute_map': { 'instance_id': 'instanceId', + 'cascade': 'cascade', 'operation_id': 'operation-id', }, 'location_map': { 'instance_id': 'path', + 'cascade': 'query', 'operation_id': 'header', }, 'collection_format_map': { @@ -680,6 +745,94 @@ def add_ai_lake_database_data_source( add_database_data_source_request return self.add_ai_lake_database_data_source_endpoint.call_with_http_info(**kwargs) + def analyze_statistics( + self, + instance_id, + analyze_statistics_request, + **kwargs + ): + """(BETA) Run ANALYZE TABLE for tables in a database instance # noqa: E501 + + (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. # 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_statistics(instance_id, analyze_statistics_request, async_req=True) + >>> result = thread.get() + + Args: + instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. + analyze_statistics_request (AnalyzeStatisticsRequest): + + Keyword Args: + operation_id (str): [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['instance_id'] = \ + instance_id + kwargs['analyze_statistics_request'] = \ + analyze_statistics_request + return self.analyze_statistics_endpoint.call_with_http_info(**kwargs) + def deprovision_ai_lake_database_instance( self, instance_id, @@ -687,7 +840,7 @@ def deprovision_ai_lake_database_instance( ): """(BETA) Delete an existing AILake Database instance # noqa: E501 - (BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress. # noqa: E501 + (BETA) Deletes an existing database in the organization's AI Lake. A database that still contains tables is not deleted, unless cascade is set. With cascade, every table in the database is dropped first, which cannot be undone. Returns an operation-id in the operation-id header the client can use to poll for the progress. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -698,6 +851,7 @@ def deprovision_ai_lake_database_instance( instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. Keyword Args: + cascade (bool): Drop every table in the database before the database itself.. [optional] operation_id (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -1020,7 +1174,7 @@ def list_ai_lake_object_storages( ): """(BETA) List registered AI Lake ObjectStorages # noqa: E501 - (BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. # noqa: E501 + (BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned. # 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/analytical_dashboard_controller_api.py b/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py index 20722c294..c824b954a 100644 --- a/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/analytical_dashboard_controller_api.py @@ -89,6 +89,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -253,6 +254,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -375,6 +377,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -478,6 +481,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -644,6 +648,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", diff --git a/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py b/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py index 65c6f8a76..f46f74cd4 100644 --- a/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attribute_controller_api.py @@ -98,6 +98,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -211,6 +212,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" diff --git a/gooddata-api-client/gooddata_api_client/api/attributes_api.py b/gooddata-api-client/gooddata_api_client/api/attributes_api.py index 0c6913a5b..d39021356 100644 --- a/gooddata-api-client/gooddata_api_client/api/attributes_api.py +++ b/gooddata-api-client/gooddata_api_client/api/attributes_api.py @@ -98,6 +98,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -211,6 +212,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" diff --git a/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py b/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py index 872307f5c..85d685aa6 100644 --- a/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automation_controller_api.py @@ -84,6 +84,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -245,6 +251,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -364,6 +376,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -464,6 +482,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -629,6 +653,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", diff --git a/gooddata-api-client/gooddata_api_client/api/automations_api.py b/gooddata-api-client/gooddata_api_client/api/automations_api.py index 7f809d9d1..bfdd1b8a6 100644 --- a/gooddata-api-client/gooddata_api_client/api/automations_api.py +++ b/gooddata-api-client/gooddata_api_client/api/automations_api.py @@ -90,6 +90,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -458,6 +464,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -637,6 +649,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -737,6 +755,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -1583,6 +1607,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", diff --git a/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py b/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py new file mode 100644 index 000000000..500e1e955 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/computed_attribute_controller_api.py @@ -0,0 +1,1312 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument + + +class ComputedAttributeControllerApi(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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes', + 'operation_id': 'create_entity_computed_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_computed_attribute_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_computed_attribute_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('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", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_computed_attribute_post_optional_id_document': + (JsonApiComputedAttributePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_computed_attribute_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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'delete_entity_computed_attributes', + '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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes', + 'operation_id': 'get_all_entities_computed_attributes', + '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", + "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", + "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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'get_entity_computed_attributes', + '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", + "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", + "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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'patch_entity_computed_attributes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('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" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_computed_attribute_patch_document': + (JsonApiComputedAttributePatchDocument,), + '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_computed_attribute_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search', + 'operation_id': 'search_entities_computed_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'update_entity_computed_attributes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('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" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_computed_attribute_in_document': + (JsonApiComputedAttributeInDocument,), + '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_computed_attribute_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_computed_attributes( + self, + workspace_id, + json_api_computed_attribute_post_optional_id_document, + **kwargs + ): + """Post 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.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_computed_attribute_post_optional_id_document (JsonApiComputedAttributePostOptionalIdDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_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 delete_entity_computed_attributes( + self, + workspace_id, + object_id, + **kwargs + ): + """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_computed_attributes(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_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_computed_attributes( + self, + workspace_id, + **kwargs + ): + """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_computed_attributes(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: + JsonApiComputedAttributeOutList + 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_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def get_entity_computed_attributes( + self, + workspace_id, + object_id, + **kwargs + ): + """Get 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.get_entity_computed_attributes(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: + JsonApiComputedAttributeOutDocument + 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_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def patch_entity_computed_attributes( + self, + workspace_id, + object_id, + json_api_computed_attribute_patch_document, + **kwargs + ): + """Patch 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.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_computed_attribute_patch_document (JsonApiComputedAttributePatchDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_computed_attribute_patch_document'] = \ + json_api_computed_attribute_patch_document + return self.patch_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def search_entities_computed_attributes( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_computed_attributes(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiComputedAttributeOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def update_entity_computed_attributes( + self, + workspace_id, + object_id, + json_api_computed_attribute_in_document, + **kwargs + ): + """Put 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.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_computed_attribute_in_document (JsonApiComputedAttributeInDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_computed_attribute_in_document'] = \ + json_api_computed_attribute_in_document + return self.update_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py b/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py new file mode 100644 index 000000000..5d355140d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/computed_attributes_api.py @@ -0,0 +1,1312 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument + + +class ComputedAttributesApi(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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes', + 'operation_id': 'create_entity_computed_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_computed_attribute_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_computed_attribute_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('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", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_computed_attribute_post_optional_id_document': + (JsonApiComputedAttributePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_computed_attribute_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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'delete_entity_computed_attributes', + '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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes', + 'operation_id': 'get_all_entities_computed_attributes', + '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", + "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", + "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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'get_entity_computed_attributes', + '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", + "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", + "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_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'patch_entity_computed_attributes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('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" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_computed_attribute_patch_document': + (JsonApiComputedAttributePatchDocument,), + '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_computed_attribute_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search', + 'operation_id': 'search_entities_computed_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'update_entity_computed_attributes', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('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" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_computed_attribute_in_document': + (JsonApiComputedAttributeInDocument,), + '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_computed_attribute_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_computed_attributes( + self, + workspace_id, + json_api_computed_attribute_post_optional_id_document, + **kwargs + ): + """Post 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.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_computed_attribute_post_optional_id_document (JsonApiComputedAttributePostOptionalIdDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_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 delete_entity_computed_attributes( + self, + workspace_id, + object_id, + **kwargs + ): + """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_computed_attributes(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_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_computed_attributes( + self, + workspace_id, + **kwargs + ): + """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_computed_attributes(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: + JsonApiComputedAttributeOutList + 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_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def get_entity_computed_attributes( + self, + workspace_id, + object_id, + **kwargs + ): + """Get 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.get_entity_computed_attributes(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: + JsonApiComputedAttributeOutDocument + 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_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def patch_entity_computed_attributes( + self, + workspace_id, + object_id, + json_api_computed_attribute_patch_document, + **kwargs + ): + """Patch 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.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_computed_attribute_patch_document (JsonApiComputedAttributePatchDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_computed_attribute_patch_document'] = \ + json_api_computed_attribute_patch_document + return self.patch_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def search_entities_computed_attributes( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_computed_attributes(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiComputedAttributeOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_computed_attributes_endpoint.call_with_http_info(**kwargs) + + def update_entity_computed_attributes( + self, + workspace_id, + object_id, + json_api_computed_attribute_in_document, + **kwargs + ): + """Put 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.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_computed_attribute_in_document (JsonApiComputedAttributeInDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_computed_attribute_in_document'] = \ + json_api_computed_attribute_in_document + return self.update_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py index 48a9ccf0b..0d2ed345f 100644 --- a/gooddata-api-client/gooddata_api_client/api/dashboards_api.py +++ b/gooddata-api-client/gooddata_api_client/api/dashboards_api.py @@ -89,6 +89,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -253,6 +254,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -375,6 +377,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -478,6 +481,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -644,6 +648,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", diff --git a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py index 11fbbcda4..1eae41e4f 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_filters_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_filters_api.py @@ -94,6 +94,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -536,6 +537,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -892,6 +894,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -1225,6 +1228,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -1749,6 +1753,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", diff --git a/gooddata-api-client/gooddata_api_client/api/data_source_statistics_api.py b/gooddata-api-client/gooddata_api_client/api/data_source_statistics_api.py index 7f0940940..8355a32d5 100644 --- a/gooddata-api-client/gooddata_api_client/api/data_source_statistics_api.py +++ b/gooddata-api-client/gooddata_api_client/api/data_source_statistics_api.py @@ -517,9 +517,9 @@ def scan_statistics( table_statistics_request, **kwargs ): - """(BETA) Collect physical table and column statistics from a StarRocks data source # noqa: E501 + """(BETA) Collect physical table and column statistics from a data source # noqa: E501 - (BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values. # noqa: E501 + (BETA) Reads the statistics the database already maintains in its own catalog, without scanning any data. Supported for StarRocks (both internal catalog for native/PIPE tables and external catalog for Iceberg tables), BigQuery, PostgreSQL, Redshift, Snowflake, Vertica, SQL Server, Azure SQL, MySQL, MariaDB and SingleStore. Statistics include row counts and data sizes, and, where the database exposes them, NDV (number of distinct values), null counts and min/max values. Returns an empty result for a data source whose database exposes no such catalog. Also returns an empty result for a data source that sets disableStatistics. # 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/entities_api.py b/gooddata-api-client/gooddata_api_client/api/entities_api.py index 849daf2a1..b60fa584e 100644 --- a/gooddata-api-client/gooddata_api_client/api/entities_api.py +++ b/gooddata-api-client/gooddata_api_client/api/entities_api.py @@ -53,6 +53,11 @@ from gooddata_api_client.model.json_api_color_palette_out_document import JsonApiColorPaletteOutDocument from gooddata_api_client.model.json_api_color_palette_out_list import JsonApiColorPaletteOutList from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument from gooddata_api_client.model.json_api_cookie_security_configuration_out_document import JsonApiCookieSecurityConfigurationOutDocument from gooddata_api_client.model.json_api_cookie_security_configuration_patch_document import JsonApiCookieSecurityConfigurationPatchDocument @@ -169,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_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 +from gooddata_api_client.model.json_api_report_page_layout_in_document import JsonApiReportPageLayoutInDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList +from gooddata_api_client.model.json_api_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument from gooddata_api_client.model.json_api_theme_out_document import JsonApiThemeOutDocument from gooddata_api_client.model.json_api_theme_out_list import JsonApiThemeOutList @@ -395,6 +415,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -639,6 +660,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -744,6 +771,104 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.create_entity_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes', + 'operation_id': 'create_entity_computed_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_computed_attribute_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_computed_attribute_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('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", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_computed_attribute_post_optional_id_document': + (JsonApiComputedAttributePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_computed_attribute_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_csp_directives_endpoint = _Endpoint( settings={ 'response_type': (JsonApiCspDirectiveOutDocument,), @@ -1328,6 +1453,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -1891,6 +2019,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -1901,6 +2030,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -2203,77 +2333,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes', - 'operation_id': 'create_entity_themes', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_theme_in_document', - ], - 'required': [ - 'json_api_theme_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), - }, - 'attribute_map': { - }, - 'location_map': { - 'json_api_theme_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_user_data_filters_endpoint = _Endpoint( + self.create_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', - 'operation_id': 'create_entity_user_data_filters', + '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_user_data_filter_post_optional_id_document', + 'json_api_report_page_layout_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_user_data_filter_post_optional_id_document', + 'json_api_report_page_layout_post_optional_id_document', ], 'nullable': [ ], @@ -2294,16 +2372,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "PARAMETERS": "parameters", - "USER": "user", - "USERGROUP": "userGroup", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -2316,8 +2387,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_user_data_filter_post_optional_id_document': - (JsonApiUserDataFilterPostOptionalIdDocument,), + 'json_api_report_page_layout_post_optional_id_document': + (JsonApiReportPageLayoutPostOptionalIdDocument,), 'include': ([str],), 'meta_include': @@ -2330,7 +2401,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'workspace_id': 'path', - 'json_api_user_data_filter_post_optional_id_document': 'body', + 'json_api_report_page_layout_post_optional_id_document': 'body', 'include': 'query', 'meta_include': 'query', }, @@ -2351,179 +2422,81 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_user_groups_endpoint = _Endpoint( + self.create_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups', - 'operation_id': 'create_entity_user_groups', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', + 'operation_id': 'create_entity_report_templates', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'json_api_user_group_in_document', + 'workspace_id', + 'json_api_report_template_post_optional_id_document', 'include', + 'meta_include', ], 'required': [ - 'json_api_user_group_in_document', + 'workspace_id', + 'json_api_report_template_post_optional_id_document', ], 'nullable': [ ], 'enum': [ 'include', + 'meta_include', ], 'validation': [ + 'meta_include', ] }, root_map={ 'validations': { + ('meta_include',): { + + }, }, 'allowed_values': { ('include',): { - "USERGROUPS": "userGroups", - "PARENTS": "parents", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, - }, - 'openapi_types': { - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), - 'include': - ([str],), - }, - 'attribute_map': { - 'include': 'include', - }, - 'location_map': { - 'json_api_user_group_in_document': 'body', - 'include': 'query', - }, - 'collection_format_map': { - 'include': 'csv', - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', - 'operation_id': 'create_entity_user_settings', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'required': [ - 'user_id', - 'json_api_user_setting_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'user_id': - (str,), - 'json_api_user_setting_in_document': - (JsonApiUserSettingInDocument,), - }, - 'attribute_map': { - 'user_id': 'userId', - }, - 'location_map': { - 'user_id': 'path', - 'json_api_user_setting_in_document': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.create_entity_users_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users', - 'operation_id': 'create_entity_users', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'json_api_user_in_document', - 'include', - ], - 'required': [ - 'json_api_user_in_document', - ], - 'nullable': [ - ], - 'enum': [ - 'include', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('include',): { + ('meta_include',): { - "USERGROUPS": "userGroups", + "ORIGIN": "origin", + "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'json_api_user_in_document': - (JsonApiUserInDocument,), + 'workspace_id': + (str,), + 'json_api_report_template_post_optional_id_document': + (JsonApiReportTemplatePostOptionalIdDocument,), 'include': ([str],), + 'meta_include': + ([str],), }, 'attribute_map': { + 'workspace_id': 'workspaceId', 'include': 'include', + 'meta_include': 'metaInclude', }, 'location_map': { - 'json_api_user_in_document': 'body', + 'workspace_id': 'path', + 'json_api_report_template_post_optional_id_document': 'body', 'include': 'query', + 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ @@ -2538,25 +2511,450 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_visualization_objects_endpoint = _Endpoint( + self.create_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'create_entity_visualization_objects', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports', + 'operation_id': 'create_entity_reports', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', + 'json_api_report_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_visualization_object_post_optional_id_document', + 'json_api_report_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_post_optional_id_document': + (JsonApiReportPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_report_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_themes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiThemeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/themes', + 'operation_id': 'create_entity_themes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_theme_in_document', + ], + 'required': [ + 'json_api_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'json_api_theme_in_document': + (JsonApiThemeInDocument,), + }, + 'attribute_map': { + }, + 'location_map': { + 'json_api_theme_in_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters', + 'operation_id': 'create_entity_user_data_filters', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_user_data_filter_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_user_data_filter_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('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", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_user_data_filter_post_optional_id_document': + (JsonApiUserDataFilterPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_user_data_filter_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_user_groups_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserGroupOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/userGroups', + 'operation_id': 'create_entity_user_groups', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_user_group_in_document', + 'include', + ], + 'required': [ + 'json_api_user_group_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'json_api_user_group_in_document': + (JsonApiUserGroupInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'include': 'include', + }, + 'location_map': { + 'json_api_user_group_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', + 'operation_id': 'create_entity_user_settings', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'json_api_user_setting_in_document', + ], + 'required': [ + 'user_id', + 'json_api_user_setting_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'user_id': + (str,), + 'json_api_user_setting_in_document': + (JsonApiUserSettingInDocument,), + }, + 'attribute_map': { + 'user_id': 'userId', + }, + 'location_map': { + 'user_id': 'path', + 'json_api_user_setting_in_document': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_users_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users', + 'operation_id': 'create_entity_users', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_user_in_document', + 'include', + ], + 'required': [ + 'json_api_user_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'json_api_user_in_document': + (JsonApiUserInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'include': 'include', + }, + 'location_map': { + 'json_api_user_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.create_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + 'operation_id': 'create_entity_visualization_objects', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_visualization_object_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_visualization_object_post_optional_id_document', ], 'nullable': [ ], @@ -2583,6 +2981,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -2591,6 +2990,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -3569,6 +3969,59 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.delete_entity_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'delete_entity_computed_attributes', + '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_csp_directives_endpoint = _Endpoint( settings={ 'response_type': None, @@ -4700,50 +5153,49 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_themes_endpoint = _Endpoint( + self.delete_entity_report_page_layouts_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'delete_entity_themes', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'delete_entity_report_page_layouts', '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': { } @@ -4754,12 +5206,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_user_data_filters_endpoint = _Endpoint( + self.delete_entity_report_templates_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}/reportTemplates/{objectId}', + 'operation_id': 'delete_entity_report_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -4807,12 +5259,65 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_user_groups_endpoint = _Endpoint( + self.delete_entity_reports_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'delete_entity_user_groups', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'delete_entity_reports', + '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_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, }, @@ -4861,56 +5366,49 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_user_settings_endpoint = _Endpoint( + self.delete_entity_user_data_filters_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'delete_entity_user_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'delete_entity_user_data_filters', 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'user_id', - 'id', + 'workspace_id', + 'object_id', ], 'required': [ - 'user_id', - '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': { - 'user_id': + 'workspace_id': (str,), - 'id': + 'object_id': (str,), }, 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', }, 'location_map': { - 'user_id': 'path', - 'id': 'path', + 'workspace_id': 'path', + 'object_id': 'path', }, 'collection_format_map': { } @@ -4921,12 +5419,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_users_endpoint = _Endpoint( + self.delete_entity_user_groups_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'delete_entity_users', + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'delete_entity_user_groups', 'http_method': 'DELETE', 'servers': None, }, @@ -4975,49 +5473,56 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_visualization_objects_endpoint = _Endpoint( + self.delete_entity_user_settings_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/users/{userId}/userSettings/{id}', + 'operation_id': 'delete_entity_user_settings', 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'object_id', + 'user_id', + 'id', ], 'required': [ - 'workspace_id', - 'object_id', + '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': { - 'workspace_id': + 'user_id': (str,), - 'object_id': + 'id': (str,), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', + 'user_id': 'userId', + 'id': 'id', }, 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', + 'user_id': 'path', + 'id': 'path', }, 'collection_format_map': { } @@ -5028,49 +5533,50 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspace_color_palettes_endpoint = _Endpoint( + self.delete_entity_users_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', - 'operation_id': 'delete_entity_workspace_color_palettes', + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'delete_entity_users', 'http_method': 'DELETE', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'object_id', + 'id', ], 'required': [ - 'workspace_id', - 'object_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': { - 'workspace_id': - (str,), - 'object_id': + 'id': (str,), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', + 'id': 'id', }, 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', + 'id': 'path', }, 'collection_format_map': { } @@ -5081,12 +5587,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( + self.delete_entity_visualization_objects_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filter_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'delete_entity_visualization_objects', 'http_method': 'DELETE', 'servers': None, }, @@ -5134,12 +5640,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspace_data_filters_endpoint = _Endpoint( + self.delete_entity_workspace_color_palettes_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', - 'operation_id': 'delete_entity_workspace_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes/{objectId}', + 'operation_id': 'delete_entity_workspace_color_palettes', 'http_method': 'DELETE', 'servers': None, }, @@ -5187,12 +5693,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspace_export_templates_endpoint = _Endpoint( + self.delete_entity_workspace_data_filter_settings_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', - 'operation_id': 'delete_entity_workspace_export_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}', + 'operation_id': 'delete_entity_workspace_data_filter_settings', 'http_method': 'DELETE', 'servers': None, }, @@ -5240,12 +5746,118 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_workspace_settings_endpoint = _Endpoint( + self.delete_entity_workspace_data_filters_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', - 'operation_id': 'delete_entity_workspace_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}', + 'operation_id': 'delete_entity_workspace_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_workspace_export_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceExportTemplates/{objectId}', + 'operation_id': 'delete_entity_workspace_export_templates', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.delete_entity_workspace_settings_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}', + 'operation_id': 'delete_entity_workspace_settings', 'http_method': 'DELETE', 'servers': None, }, @@ -5823,6 +6435,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -6163,6 +6776,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -6281,6 +6895,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -6435,6 +7055,135 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.get_all_entities_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes', + 'operation_id': 'get_all_entities_computed_attributes', + '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", + "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", + "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_csp_directives_endpoint = _Endpoint( settings={ 'response_type': (JsonApiCspDirectiveOutList,), @@ -7542,6 +8291,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -7658,6 +8408,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -8383,6 +9136,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -8701,6 +9455,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -8711,6 +9466,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -9232,27 +9988,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': [ @@ -9266,40 +10030,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', } @@ -9313,12 +10108,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, }, @@ -9363,16 +10158,9 @@ def __init__(self, api_client=None): }, ('include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "PARAMETERS": "parameters", - "USER": "user", - "USERGROUP": "userGroup", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -9440,28 +10228,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', ], @@ -9476,20 +10270,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': @@ -9500,23 +10306,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': { @@ -9534,12 +10348,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, }, @@ -9615,30 +10429,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': [ @@ -9652,44 +10471,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', } @@ -9703,12 +10557,12 @@ 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, }, @@ -9742,6 +10596,7 @@ def __init__(self, api_client=None): ('include',): { "USERGROUPS": "userGroups", + "PARENTS": "parents", "ALL": "ALL" }, ('meta_include',): { @@ -9796,35 +10651,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_visualization_objects_endpoint = _Endpoint( + self.get_all_entities_user_identifiers_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiVisualizationObjectOutList,), + 'response_type': (JsonApiUserIdentifierOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', - 'operation_id': 'get_all_entities_visualization_objects', + 'endpoint_path': '/api/v1/entities/userIdentifiers', + 'operation_id': 'get_all_entities_user_identifiers', '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': [ @@ -9838,78 +10685,40 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "PARAMETERS": "parameters", - "DATASETS": "datasets", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "CERTIFIEDBY": "certifiedBy", - "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', } @@ -9923,33 +10732,30 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_workspace_color_palettes_endpoint = _Endpoint( + self.get_all_entities_user_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceColorPaletteOutList,), + 'response_type': (JsonApiUserSettingOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', - 'operation_id': 'get_all_entities_workspace_color_palettes', + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings', + 'operation_id': 'get_all_entities_user_settings', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'origin', + 'user_id', 'filter', 'page', 'size', 'sort', - 'x_gdc_validate_relations', 'meta_include', ], 'required': [ - 'workspace_id', + 'user_id', ], 'nullable': [ ], 'enum': [ - 'origin', 'meta_include', ], 'validation': [ @@ -9963,24 +10769,15 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, ('meta_include',): { - "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'workspace_id': - (str,), - 'origin': + 'user_id': (str,), 'filter': (str,), @@ -9990,29 +10787,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', + 'user_id': 'userId', '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', + 'user_id': 'path', 'filter': 'query', 'page': 'query', 'size': 'query', 'sort': 'query', - 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { @@ -10029,34 +10820,28 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( + self.get_all_entities_users_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), + 'response_type': (JsonApiUserOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', - 'operation_id': 'get_all_entities_workspace_data_filter_settings', + 'endpoint_path': '/api/v1/entities/users', + 'operation_id': 'get_all_entities_users', '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', ], @@ -10071,31 +10856,19 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, ('include',): { - "WORKSPACEDATAFILTERS": "workspaceDataFilters", - "WORKSPACEDATAFILTER": "workspaceDataFilter", + "USERGROUPS": "userGroups", "ALL": "ALL" }, ('meta_include',): { - "ORIGIN": "origin", "PAGE": "page", "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'workspace_id': - (str,), - 'origin': - (str,), 'filter': (str,), 'include': @@ -10106,31 +10879,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': { @@ -10148,12 +10913,366 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_workspace_data_filters_endpoint = _Endpoint( + self.get_all_entities_visualization_objects_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiWorkspaceDataFilterOutList,), + 'response_type': (JsonApiVisualizationObjectOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', - 'operation_id': 'get_all_entities_workspace_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects', + 'operation_id': 'get_all_entities_visualization_objects', + '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", + "FACTS": "facts", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "METRICS": "metrics", + "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", + "DATASETS": "datasets", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "CERTIFIEDBY": "certifiedBy", + "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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_color_palettes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceColorPaletteOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceColorPalettes', + 'operation_id': 'get_all_entities_workspace_color_palettes', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'origin', + 'filter', + 'page', + 'size', + 'sort', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'origin': + (str,), + 'filter': + (str,), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'filter': 'filter', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'origin': 'query', + 'filter': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_workspace_data_filter_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterSettingOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings', + 'operation_id': 'get_all_entities_workspace_data_filter_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', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + ('include',): { + + "WORKSPACEDATAFILTERS": "workspaceDataFilters", + "WORKSPACEDATAFILTER": "workspaceDataFilter", + "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_workspace_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiWorkspaceDataFilterOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters', + 'operation_id': 'get_all_entities_workspace_data_filters', 'http_method': 'GET', 'servers': None, }, @@ -11041,6 +12160,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -11315,6 +12435,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -11410,6 +12531,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -11531,136 +12658,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_cookie_security_configurations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'get_entity_cookie_security_configurations', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'get_entity_csp_directives', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_custom_application_settings_endpoint = _Endpoint( + self.get_entity_computed_attributes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), + 'response_type': (JsonApiComputedAttributeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'get_entity_custom_application_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'get_entity_computed_attributes', 'http_method': 'GET', 'servers': None, }, @@ -11669,6 +12672,7 @@ def __init__(self, api_client=None): 'workspace_id', 'object_id', 'filter', + 'include', 'x_gdc_validate_relations', 'meta_include', ], @@ -11679,6 +12683,7 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ + 'include', 'meta_include', ], 'validation': [ @@ -11692,8 +12697,24 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('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", "ALL": "all", "ALL": "ALL" @@ -11706,6 +12727,8 @@ def __init__(self, api_client=None): (str,), 'filter': (str,), + 'include': + ([str],), 'x_gdc_validate_relations': (bool,), 'meta_include': @@ -11715,6 +12738,7 @@ def __init__(self, api_client=None): 'workspace_id': 'workspaceId', 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, @@ -11722,10 +12746,12 @@ def __init__(self, api_client=None): 'workspace_id': 'path', 'object_id': 'path', 'filter': 'query', + 'include': 'query', 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { + 'include': 'csv', 'meta_include': 'csv', } }, @@ -11738,12 +12764,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_custom_geo_collections_endpoint = _Endpoint( + self.get_entity_cookie_security_configurations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', - 'operation_id': 'get_entity_custom_geo_collections', + 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + 'operation_id': 'get_entity_cookie_security_configurations', 'http_method': 'GET', 'servers': None, }, @@ -11800,23 +12826,21 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_custom_user_application_settings_endpoint = _Endpoint( + self.get_entity_csp_directives_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomUserApplicationSettingOutDocument,), + 'response_type': (JsonApiCspDirectiveOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}', - 'operation_id': 'get_entity_custom_user_application_settings', + 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', + 'operation_id': 'get_entity_csp_directives', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'user_id', 'id', 'filter', ], 'required': [ - 'user_id', 'id', ], 'nullable': [ @@ -11839,20 +12863,16 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'user_id': - (str,), 'id': (str,), 'filter': (str,), }, 'attribute_map': { - 'user_id': 'userId', 'id': 'id', 'filter': 'filter', }, 'location_map': { - 'user_id': 'path', 'id': 'path', 'filter': 'query', }, @@ -11868,12 +12888,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_dashboard_plugins_endpoint = _Endpoint( + self.get_entity_custom_application_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), + 'response_type': (JsonApiCustomApplicationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'get_entity_dashboard_plugins', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + 'operation_id': 'get_entity_custom_application_settings', 'http_method': 'GET', 'servers': None, }, @@ -11882,7 +12902,6 @@ def __init__(self, api_client=None): 'workspace_id', 'object_id', 'filter', - 'include', 'x_gdc_validate_relations', 'meta_include', ], @@ -11893,7 +12912,6 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'include', 'meta_include', ], 'validation': [ @@ -11907,13 +12925,6 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, ('meta_include',): { "ORIGIN": "origin", @@ -11928,8 +12939,6 @@ def __init__(self, api_client=None): (str,), 'filter': (str,), - 'include': - ([str],), 'x_gdc_validate_relations': (bool,), 'meta_include': @@ -11939,7 +12948,6 @@ def __init__(self, api_client=None): 'workspace_id': 'workspaceId', 'object_id': 'objectId', 'filter': 'filter', - 'include': 'include', 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', 'meta_include': 'metaInclude', }, @@ -11947,12 +12955,10 @@ def __init__(self, api_client=None): 'workspace_id': 'path', 'object_id': 'path', 'filter': 'query', - 'include': 'query', 'x_gdc_validate_relations': 'header', 'meta_include': 'query', }, 'collection_format_map': { - 'include': 'csv', 'meta_include': 'csv', } }, @@ -11965,12 +12971,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_data_source_identifiers_endpoint = _Endpoint( + self.get_entity_custom_geo_collections_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceIdentifierOutDocument,), + 'response_type': (JsonApiCustomGeoCollectionOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', - 'operation_id': 'get_entity_data_source_identifiers', + 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', + 'operation_id': 'get_entity_custom_geo_collections', 'http_method': 'GET', 'servers': None, }, @@ -11978,7 +12984,6 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', - 'meta_include', ], 'required': [ 'id', @@ -11986,11 +12991,9 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -12001,38 +13004,24 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, }, 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), - 'meta_include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'meta_include': 'metaInclude', }, 'location_map': { 'id': 'path', 'filter': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'meta_include': 'csv', } }, headers_map={ @@ -12044,32 +13033,31 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_data_sources_endpoint = _Endpoint( + self.get_entity_custom_user_application_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceOutDocument,), + 'response_type': (JsonApiCustomUserApplicationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'get_entity_data_sources', + 'endpoint_path': '/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}', + 'operation_id': 'get_entity_custom_user_application_settings', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ + 'user_id', 'id', 'filter', - 'meta_include', ], 'required': [ + 'user_id', 'id', ], 'nullable': [ ], 'enum': [ - 'meta_include', ], 'validation': [ 'id', - 'meta_include', ] }, root_map={ @@ -12080,38 +13068,28 @@ def __init__(self, api_client=None): 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 }, }, - ('meta_include',): { - - }, }, 'allowed_values': { - ('meta_include',): { - - "PERMISSIONS": "permissions", - "ALL": "all", - "ALL": "ALL" - }, }, 'openapi_types': { + 'user_id': + (str,), 'id': (str,), 'filter': (str,), - 'meta_include': - ([str],), }, 'attribute_map': { + 'user_id': 'userId', 'id': 'id', 'filter': 'filter', - 'meta_include': 'metaInclude', }, 'location_map': { + 'user_id': 'path', 'id': 'path', 'filter': 'query', - 'meta_include': 'query', }, 'collection_format_map': { - 'meta_include': 'csv', } }, headers_map={ @@ -12123,12 +13101,267 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_datasets_endpoint = _Endpoint( + self.get_entity_dashboard_plugins_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDatasetOutDocument,), + 'response_type': (JsonApiDashboardPluginOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', - 'operation_id': 'get_entity_datasets', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + 'operation_id': 'get_entity_dashboard_plugins', + '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_data_source_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDataSourceIdentifierOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/dataSourceIdentifiers/{id}', + 'operation_id': 'get_entity_data_source_identifiers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'meta_include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'id', + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_data_sources_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDataSourceOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/dataSources/{id}', + 'operation_id': 'get_entity_data_sources', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'meta_include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'meta_include', + ], + 'validation': [ + 'id', + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('meta_include',): { + + "PERMISSIONS": "permissions", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_datasets_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiDatasetOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}', + 'operation_id': 'get_entity_datasets', 'http_method': 'GET', 'servers': None, }, @@ -12497,6 +13730,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -12590,6 +13824,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -13134,6 +14371,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -13387,6 +14625,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -13397,6 +14636,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -13901,74 +15141,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_themes_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiThemeOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'get_entity_themes', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'filter', - ], - 'required': [ - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_data_filters_endpoint = _Endpoint( + self.get_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'get_entity_user_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'get_entity_report_page_layouts', 'http_method': 'GET', 'servers': None, }, @@ -14004,16 +15182,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "PARAMETERS": "parameters", - "USER": "user", - "USERGROUP": "userGroup", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -14067,70 +15238,92 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_user_groups_endpoint = _Endpoint( + self.get_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'get_entity_user_groups', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'get_entity_report_templates', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'object_id', 'filter', 'include', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ - 'id', + 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ 'include', + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { ('include',): { - "USERGROUPS": "userGroups", - "PARENTS": "parents", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", "ALL": "ALL" }, }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'object_id': (str,), 'filter': (str,), 'include': ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', + '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={ @@ -14142,125 +15335,92 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_user_identifiers_endpoint = _Endpoint( + self.get_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserIdentifierOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', - 'operation_id': 'get_entity_user_identifiers', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'get_entity_reports', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'object_id', 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ - 'id', + 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ + 'include', + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [], - }, - api_client=api_client - ) - self.get_entity_user_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiUserSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'get_entity_user_settings', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'user_id', - 'id', - 'filter', - ], - 'required': [ - 'user_id', - 'id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { + ('include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" }, - }, - 'allowed_values': { }, 'openapi_types': { - 'user_id': + 'workspace_id': (str,), - 'id': + 'object_id': (str,), 'filter': (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'user_id': 'userId', - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { - 'user_id': 'path', - 'id': 'path', + '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={ @@ -14272,12 +15432,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_users_endpoint = _Endpoint( + self.get_entity_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserOutDocument,), + 'response_type': (JsonApiThemeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{id}', - 'operation_id': 'get_entity_users', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'get_entity_themes', 'http_method': 'GET', 'servers': None, }, @@ -14285,7 +15445,6 @@ def __init__(self, api_client=None): 'all': [ 'id', 'filter', - 'include', ], 'required': [ 'id', @@ -14293,7 +15452,6 @@ def __init__(self, api_client=None): 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ 'id', @@ -14309,32 +15467,22 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { - ('include',): { - - "USERGROUPS": "userGroups", - "ALL": "ALL" - }, }, 'openapi_types': { 'id': (str,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { 'id': 'path', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -14346,12 +15494,396 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_visualization_objects_endpoint = _Endpoint( + self.get_entity_user_data_filters_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'response_type': (JsonApiUserDataFilterOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', - 'operation_id': 'get_entity_visualization_objects', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'get_entity_user_data_filters', + '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',): { + + "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", + "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_user_groups_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserGroupOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'get_entity_user_groups', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_user_identifiers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserIdentifierOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/userIdentifiers/{id}', + 'operation_id': 'get_entity_user_identifiers', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', + 'operation_id': 'get_entity_user_settings', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'filter', + ], + '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,), + 'filter': + (str,), + }, + 'attribute_map': { + 'user_id': 'userId', + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'user_id': 'path', + 'id': 'path', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_users_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{id}', + 'operation_id': 'get_entity_users', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_visualization_objects_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiVisualizationObjectOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}', + 'operation_id': 'get_entity_visualization_objects', 'http_method': 'GET', 'servers': None, }, @@ -14393,6 +15925,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -14401,6 +15934,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -15302,6 +16836,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -15559,6 +17094,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -15679,6 +17220,97 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'patch_entity_computed_attributes', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_computed_attribute_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('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" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_computed_attribute_patch_document': + (JsonApiComputedAttributePatchDocument,), + '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_computed_attribute_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_cookie_security_configurations_endpoint = _Endpoint( settings={ 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), @@ -16477,6 +18109,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, }, @@ -17104,6 +18739,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -17548,6 +19184,255 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.patch_entity_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportPageLayoutOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'patch_entity_report_page_layouts', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_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_report_page_layout_patch_document': + (JsonApiReportPageLayoutPatchDocument,), + '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_report_page_layout_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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'patch_entity_report_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_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_report_template_patch_document': + (JsonApiReportTemplatePatchDocument,), + '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_report_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_reports_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'patch_entity_reports', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_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_report_patch_document': + (JsonApiReportPatchDocument,), + '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_report_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_themes_endpoint = _Endpoint( settings={ 'response_type': (JsonApiThemeOutDocument,), @@ -17659,6 +19544,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -17915,6 +19801,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -18930,6 +20817,80 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.search_entities_computed_attributes_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiComputedAttributeOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search', + 'operation_id': 'search_entities_computed_attributes', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.search_entities_custom_application_settings_endpoint = _Endpoint( settings={ 'response_type': (JsonApiCustomApplicationSettingOutList,), @@ -20365,6 +22326,7 @@ def __init__(self, api_client=None): "DATASETS": "datasets", "FILTERCONTEXTS": "filterContexts", "DASHBOARDPLUGINS": "dashboardPlugins", + "COMPUTEDATTRIBUTES": "computedAttributes", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", "CERTIFIEDBY": "certifiedBy", @@ -20537,6 +22499,12 @@ def __init__(self, api_client=None): "USERIDENTIFIERS": "userIdentifiers", "EXPORTDEFINITIONS": "exportDefinitions", "USERS": "users", + "VISUALIZATIONOBJECTS": "visualizationObjects", + "METRICS": "metrics", + "ATTRIBUTES": "attributes", + "LABELS": "labels", + "FACTS": "facts", + "COMPUTEDATTRIBUTES": "computedAttributes", "AUTOMATIONRESULTS": "automationResults", "NOTIFICATIONCHANNEL": "notificationChannel", "ANALYTICALDASHBOARD": "analyticalDashboard", @@ -20657,152 +22625,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_cookie_security_configurations_endpoint = _Endpoint( + self.update_entity_computed_attributes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), + 'response_type': (JsonApiComputedAttributeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', - 'operation_id': 'update_entity_cookie_security_configurations', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_cookie_security_configuration_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_cookie_security_configuration_in_document': - (JsonApiCookieSecurityConfigurationInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_cookie_security_configuration_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_csp_directives_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCspDirectiveOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', - 'operation_id': 'update_entity_csp_directives', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'id', - 'json_api_csp_directive_in_document', - 'filter', - ], - 'required': [ - 'id', - 'json_api_csp_directive_in_document', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'id', - ] - }, - root_map={ - 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'id': - (str,), - 'json_api_csp_directive_in_document': - (JsonApiCspDirectiveInDocument,), - 'filter': - (str,), - }, - 'attribute_map': { - 'id': 'id', - 'filter': 'filter', - }, - 'location_map': { - 'id': 'path', - 'json_api_csp_directive_in_document': 'body', - 'filter': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ] - }, - api_client=api_client - ) - self.update_entity_custom_application_settings_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiCustomApplicationSettingOutDocument,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', - 'operation_id': 'update_entity_custom_application_settings', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}', + 'operation_id': 'update_entity_computed_attributes', 'http_method': 'PUT', 'servers': None, }, @@ -20810,17 +22638,19 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_custom_application_setting_in_document', + 'json_api_computed_attribute_in_document', 'filter', + 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_custom_application_setting_in_document', + 'json_api_computed_attribute_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ ] @@ -20829,29 +22659,49 @@ def __init__(self, api_client=None): 'validations': { }, 'allowed_values': { + ('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" + }, }, 'openapi_types': { 'workspace_id': (str,), 'object_id': (str,), - 'json_api_custom_application_setting_in_document': - (JsonApiCustomApplicationSettingInDocument,), + 'json_api_computed_attribute_in_document': + (JsonApiComputedAttributeInDocument,), '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_custom_application_setting_in_document': 'body', + 'json_api_computed_attribute_in_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -20866,24 +22716,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_custom_geo_collections_endpoint = _Endpoint( + self.update_entity_cookie_security_configurations_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomGeoCollectionOutDocument,), + 'response_type': (JsonApiCookieSecurityConfigurationOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', - 'operation_id': 'update_entity_custom_geo_collections', + 'endpoint_path': '/api/v1/entities/admin/cookieSecurityConfigurations/{id}', + 'operation_id': 'update_entity_cookie_security_configurations', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_custom_geo_collection_in_document', + 'json_api_cookie_security_configuration_in_document', 'filter', ], 'required': [ 'id', - 'json_api_custom_geo_collection_in_document', + 'json_api_cookie_security_configuration_in_document', ], 'nullable': [ ], @@ -20907,8 +22757,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_custom_geo_collection_in_document': - (JsonApiCustomGeoCollectionInDocument,), + 'json_api_cookie_security_configuration_in_document': + (JsonApiCookieSecurityConfigurationInDocument,), 'filter': (str,), }, @@ -20918,7 +22768,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_custom_geo_collection_in_document': 'body', + 'json_api_cookie_security_configuration_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -20936,26 +22786,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_custom_user_application_settings_endpoint = _Endpoint( + self.update_entity_csp_directives_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiCustomUserApplicationSettingOutDocument,), + 'response_type': (JsonApiCspDirectiveOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}', - 'operation_id': 'update_entity_custom_user_application_settings', + 'endpoint_path': '/api/v1/entities/cspDirectives/{id}', + 'operation_id': 'update_entity_csp_directives', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'user_id', 'id', - 'json_api_custom_user_application_setting_in_document', + 'json_api_csp_directive_in_document', 'filter', ], 'required': [ - 'user_id', 'id', - 'json_api_custom_user_application_setting_in_document', + 'json_api_csp_directive_in_document', ], 'nullable': [ ], @@ -20977,24 +22825,20 @@ def __init__(self, api_client=None): 'allowed_values': { }, 'openapi_types': { - 'user_id': - (str,), 'id': (str,), - 'json_api_custom_user_application_setting_in_document': - (JsonApiCustomUserApplicationSettingInDocument,), + 'json_api_csp_directive_in_document': + (JsonApiCspDirectiveInDocument,), 'filter': (str,), }, 'attribute_map': { - 'user_id': 'userId', 'id': 'id', 'filter': 'filter', }, 'location_map': { - 'user_id': 'path', 'id': 'path', - 'json_api_custom_user_application_setting_in_document': 'body', + 'json_api_csp_directive_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -21012,12 +22856,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_dashboard_plugins_endpoint = _Endpoint( + self.update_entity_custom_application_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDashboardPluginOutDocument,), + 'response_type': (JsonApiCustomApplicationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', - 'operation_id': 'update_entity_dashboard_plugins', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}', + 'operation_id': 'update_entity_custom_application_settings', 'http_method': 'PUT', 'servers': None, }, @@ -21025,19 +22869,17 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_dashboard_plugin_in_document', + 'json_api_custom_application_setting_in_document', 'filter', - 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_dashboard_plugin_in_document', + 'json_api_custom_application_setting_in_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ ] @@ -21046,41 +22888,29 @@ def __init__(self, api_client=None): 'validations': { }, 'allowed_values': { - ('include',): { - - "USERIDENTIFIERS": "userIdentifiers", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" - }, }, 'openapi_types': { 'workspace_id': (str,), 'object_id': (str,), - 'json_api_dashboard_plugin_in_document': - (JsonApiDashboardPluginInDocument,), + 'json_api_custom_application_setting_in_document': + (JsonApiCustomApplicationSettingInDocument,), '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_dashboard_plugin_in_document': 'body', + 'json_api_custom_application_setting_in_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -21095,24 +22925,24 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_data_sources_endpoint = _Endpoint( + self.update_entity_custom_geo_collections_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDataSourceOutDocument,), + 'response_type': (JsonApiCustomGeoCollectionOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/dataSources/{id}', - 'operation_id': 'update_entity_data_sources', + 'endpoint_path': '/api/v1/entities/customGeoCollections/{id}', + 'operation_id': 'update_entity_custom_geo_collections', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_data_source_in_document', + 'json_api_custom_geo_collection_in_document', 'filter', ], 'required': [ 'id', - 'json_api_data_source_in_document', + 'json_api_custom_geo_collection_in_document', ], 'nullable': [ ], @@ -21136,8 +22966,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'id': (str,), - 'json_api_data_source_in_document': - (JsonApiDataSourceInDocument,), + 'json_api_custom_geo_collection_in_document': + (JsonApiCustomGeoCollectionInDocument,), 'filter': (str,), }, @@ -21147,7 +22977,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'id': 'path', - 'json_api_data_source_in_document': 'body', + 'json_api_custom_geo_collection_in_document': 'body', 'filter': 'query', }, 'collection_format_map': { @@ -21165,81 +22995,68 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_export_definitions_endpoint = _Endpoint( + self.update_entity_custom_user_application_settings_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportDefinitionOutDocument,), + 'response_type': (JsonApiCustomUserApplicationSettingOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', - 'operation_id': 'update_entity_export_definitions', + 'endpoint_path': '/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}', + 'operation_id': 'update_entity_custom_user_application_settings', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', + 'user_id', + 'id', + 'json_api_custom_user_application_setting_in_document', 'filter', - 'include', ], 'required': [ - 'workspace_id', - 'object_id', - 'json_api_export_definition_in_document', + 'user_id', + 'id', + 'json_api_custom_user_application_setting_in_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ + 'id', ] }, root_map={ 'validations': { - }, - 'allowed_values': { - ('include',): { + ('id',): { - "VISUALIZATIONOBJECTS": "visualizationObjects", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "AUTOMATIONS": "automations", - "USERIDENTIFIERS": "userIdentifiers", - "VISUALIZATIONOBJECT": "visualizationObject", - "ANALYTICALDASHBOARD": "analyticalDashboard", - "AUTOMATION": "automation", - "CREATEDBY": "createdBy", - "MODIFIEDBY": "modifiedBy", - "ALL": "ALL" + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, }, }, + 'allowed_values': { + }, 'openapi_types': { - 'workspace_id': + 'user_id': (str,), - 'object_id': + 'id': (str,), - 'json_api_export_definition_in_document': - (JsonApiExportDefinitionInDocument,), + 'json_api_custom_user_application_setting_in_document': + (JsonApiCustomUserApplicationSettingInDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', + 'user_id': 'userId', + 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_export_definition_in_document': 'body', + 'user_id': 'path', + 'id': 'path', + 'json_api_custom_user_application_setting_in_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -21254,62 +23071,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_export_templates_endpoint = _Endpoint( + self.update_entity_dashboard_plugins_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiExportTemplateOutDocument,), + 'response_type': (JsonApiDashboardPluginOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', - 'operation_id': 'update_entity_export_templates', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}', + 'operation_id': 'update_entity_dashboard_plugins', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_export_template_in_document', + 'workspace_id', + 'object_id', + 'json_api_dashboard_plugin_in_document', 'filter', + 'include', ], 'required': [ - 'id', - 'json_api_export_template_in_document', + 'workspace_id', + 'object_id', + 'json_api_dashboard_plugin_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': + 'workspace_id': (str,), - 'json_api_export_template_in_document': - (JsonApiExportTemplateInDocument,), + 'object_id': + (str,), + 'json_api_dashboard_plugin_in_document': + (JsonApiDashboardPluginInDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', }, 'location_map': { - 'id': 'path', - 'json_api_export_template_in_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_dashboard_plugin_in_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -21324,75 +23154,62 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_filter_contexts_endpoint = _Endpoint( + self.update_entity_data_sources_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterContextOutDocument,), + 'response_type': (JsonApiDataSourceOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', - 'operation_id': 'update_entity_filter_contexts', + 'endpoint_path': '/api/v1/entities/dataSources/{id}', + 'operation_id': 'update_entity_data_sources', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', + 'id', + 'json_api_data_source_in_document', 'filter', - 'include', ], 'required': [ - 'workspace_id', - 'object_id', - 'json_api_filter_context_in_document', + 'id', + 'json_api_data_source_in_document', ], 'nullable': [ ], 'enum': [ - 'include', ], 'validation': [ + 'id', ] }, root_map={ 'validations': { - }, - 'allowed_values': { - ('include',): { + ('id',): { - "ATTRIBUTES": "attributes", - "DATASETS": "datasets", - "LABELS": "labels", - "ALL": "ALL" + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, }, }, + 'allowed_values': { + }, 'openapi_types': { - 'workspace_id': - (str,), - 'object_id': + 'id': (str,), - 'json_api_filter_context_in_document': - (JsonApiFilterContextInDocument,), + 'json_api_data_source_in_document': + (JsonApiDataSourceInDocument,), 'filter': (str,), - 'include': - ([str],), }, 'attribute_map': { - 'workspace_id': 'workspaceId', - 'object_id': 'objectId', + 'id': 'id', 'filter': 'filter', - 'include': 'include', }, 'location_map': { - 'workspace_id': 'path', - 'object_id': 'path', - 'json_api_filter_context_in_document': 'body', + 'id': 'path', + 'json_api_data_source_in_document': 'body', 'filter': 'query', - 'include': 'query', }, 'collection_format_map': { - 'include': 'csv', } }, headers_map={ @@ -21407,12 +23224,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_filter_views_endpoint = _Endpoint( + self.update_entity_export_definitions_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiFilterViewOutDocument,), + 'response_type': (JsonApiExportDefinitionOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', - 'operation_id': 'update_entity_filter_views', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}', + 'operation_id': 'update_entity_export_definitions', 'http_method': 'PUT', 'servers': None, }, @@ -21420,14 +23237,14 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_filter_view_in_document', + 'json_api_export_definition_in_document', 'filter', 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_filter_view_in_document', + 'json_api_export_definition_in_document', ], 'nullable': [ ], @@ -21443,10 +23260,15 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { + "VISUALIZATIONOBJECTS": "visualizationObjects", "ANALYTICALDASHBOARDS": "analyticalDashboards", - "USERS": "users", + "AUTOMATIONS": "automations", + "USERIDENTIFIERS": "userIdentifiers", + "VISUALIZATIONOBJECT": "visualizationObject", "ANALYTICALDASHBOARD": "analyticalDashboard", - "USER": "user", + "AUTOMATION": "automation", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, }, @@ -21455,8 +23277,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_filter_view_in_document': - (JsonApiFilterViewInDocument,), + 'json_api_export_definition_in_document': + (JsonApiExportDefinitionInDocument,), 'filter': (str,), 'include': @@ -21471,7 +23293,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_filter_view_in_document': 'body', + 'json_api_export_definition_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -21491,24 +23313,264 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_identity_providers_endpoint = _Endpoint( + self.update_entity_export_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiIdentityProviderOutDocument,), + 'response_type': (JsonApiExportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/identityProviders/{id}', - 'operation_id': 'update_entity_identity_providers', + 'endpoint_path': '/api/v1/entities/exportTemplates/{id}', + 'operation_id': 'update_entity_export_templates', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ 'id', - 'json_api_identity_provider_in_document', + 'json_api_export_template_in_document', 'filter', ], 'required': [ 'id', - 'json_api_identity_provider_in_document', + 'json_api_export_template_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_export_template_in_document': + (JsonApiExportTemplateInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_export_template_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_filter_contexts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterContextOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}', + 'operation_id': 'update_entity_filter_contexts', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_context_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ATTRIBUTES": "attributes", + "DATASETS": "datasets", + "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_filter_context_in_document': + (JsonApiFilterContextInDocument,), + '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_filter_context_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_filter_views_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiFilterViewOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}', + 'operation_id': 'update_entity_filter_views', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_filter_view_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_filter_view_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "USERS": "users", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "USER": "user", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_filter_view_in_document': + (JsonApiFilterViewInDocument,), + '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_filter_view_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_identity_providers_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiIdentityProviderOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/identityProviders/{id}', + 'operation_id': 'update_entity_identity_providers', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_identity_provider_in_document', + 'filter', + ], + 'required': [ + 'id', + 'json_api_identity_provider_in_document', ], 'nullable': [ ], @@ -21991,6 +24053,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -22435,62 +24498,75 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_themes_endpoint = _Endpoint( + self.update_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiThemeOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/themes/{id}', - 'operation_id': 'update_entity_themes', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'update_entity_report_page_layouts', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_theme_in_document', + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_in_document', 'filter', + 'include', ], 'required': [ - 'id', - 'json_api_theme_in_document', + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_in_document', ], 'nullable': [ ], 'enum': [ + 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': + 'workspace_id': (str,), - 'json_api_theme_in_document': - (JsonApiThemeInDocument,), + 'object_id': + (str,), + 'json_api_report_page_layout_in_document': + (JsonApiReportPageLayoutInDocument,), 'filter': (str,), + 'include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', + 'include': 'include', }, 'location_map': { - 'id': 'path', - 'json_api_theme_in_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_report_page_layout_in_document': 'body', 'filter': 'query', + 'include': 'query', }, 'collection_format_map': { + 'include': 'csv', } }, headers_map={ @@ -22505,12 +24581,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_user_data_filters_endpoint = _Endpoint( + self.update_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserDataFilterOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', - 'operation_id': 'update_entity_user_data_filters', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'update_entity_report_templates', 'http_method': 'PUT', 'servers': None, }, @@ -22518,14 +24594,14 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_user_data_filter_in_document', + 'json_api_report_template_in_document', 'filter', 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_user_data_filter_in_document', + 'json_api_report_template_in_document', ], 'nullable': [ ], @@ -22541,16 +24617,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "USERS": "users", - "USERGROUPS": "userGroups", - "FACTS": "facts", - "ATTRIBUTES": "attributes", - "LABELS": "labels", - "METRICS": "metrics", - "DATASETS": "datasets", - "PARAMETERS": "parameters", - "USER": "user", - "USERGROUP": "userGroup", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, }, @@ -22559,8 +24628,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_user_data_filter_in_document': - (JsonApiUserDataFilterInDocument,), + 'json_api_report_template_in_document': + (JsonApiReportTemplateInDocument,), 'filter': (str,), 'include': @@ -22575,7 +24644,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_user_data_filter_in_document': 'body', + 'json_api_report_template_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -22595,25 +24664,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_user_groups_endpoint = _Endpoint( + self.update_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserGroupOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/userGroups/{id}', - 'operation_id': 'update_entity_user_groups', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'update_entity_reports', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_user_group_in_document', + 'workspace_id', + 'object_id', + 'json_api_report_in_document', 'filter', 'include', ], 'required': [ - 'id', - 'json_api_user_group_in_document', + 'workspace_id', + 'object_id', + 'json_api_report_in_document', ], 'nullable': [ ], @@ -22621,44 +24692,42 @@ def __init__(self, api_client=None): 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { ('include',): { - "USERGROUPS": "userGroups", - "PARENTS": "parents", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, }, 'openapi_types': { - 'id': + 'workspace_id': (str,), - 'json_api_user_group_in_document': - (JsonApiUserGroupInDocument,), + 'object_id': + (str,), + 'json_api_report_in_document': + (JsonApiReportInDocument,), 'filter': (str,), 'include': ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', 'include': 'include', }, 'location_map': { - 'id': 'path', - 'json_api_user_group_in_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_report_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -22678,26 +24747,270 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_user_settings_endpoint = _Endpoint( + self.update_entity_themes_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiUserSettingOutDocument,), + 'response_type': (JsonApiThemeOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', - 'operation_id': 'update_entity_user_settings', + 'endpoint_path': '/api/v1/entities/themes/{id}', + 'operation_id': 'update_entity_themes', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'user_id', 'id', - 'json_api_user_setting_in_document', + 'json_api_theme_in_document', 'filter', ], 'required': [ - 'user_id', 'id', - 'json_api_user_setting_in_document', + 'json_api_theme_in_document', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_theme_in_document': + (JsonApiThemeInDocument,), + 'filter': + (str,), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + }, + 'location_map': { + 'id': 'path', + 'json_api_theme_in_document': 'body', + 'filter': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_user_data_filters_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserDataFilterOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}', + 'operation_id': 'update_entity_user_data_filters', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_user_data_filter_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_user_data_filter_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('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" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_user_data_filter_in_document': + (JsonApiUserDataFilterInDocument,), + '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_user_data_filter_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_user_groups_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserGroupOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/userGroups/{id}', + 'operation_id': 'update_entity_user_groups', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_user_group_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_user_group_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERGROUPS": "userGroups", + "PARENTS": "parents", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_user_group_in_document': + (JsonApiUserGroupInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_user_group_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_user_settings_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiUserSettingOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/users/{userId}/userSettings/{id}', + 'operation_id': 'update_entity_user_settings', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'user_id', + 'id', + 'json_api_user_setting_in_document', + 'filter', + ], + 'required': [ + 'user_id', + 'id', + 'json_api_user_setting_in_document', ], 'nullable': [ ], @@ -22878,6 +25191,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -23696,113 +26010,2245 @@ def create_entity_analytical_dashboards( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ - json_api_analytical_dashboard_post_optional_id_document - return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - - def create_entity_api_tokens( - self, - user_id, - json_api_api_token_in_document, - **kwargs - ): - """Post a new API token for the user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) - >>> result = thread.get() - - Args: - user_id (str): - json_api_api_token_in_document (JsonApiApiTokenInDocument): - - 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: - JsonApiApiTokenOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['json_api_api_token_in_document'] = \ - json_api_api_token_in_document - return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_analytical_dashboard_post_optional_id_document'] = \ + json_api_analytical_dashboard_post_optional_id_document + return self.create_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + + def create_entity_api_tokens( + self, + user_id, + json_api_api_token_in_document, + **kwargs + ): + """Post a new API token for the user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_api_tokens(user_id, json_api_api_token_in_document, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + json_api_api_token_in_document (JsonApiApiTokenInDocument): + + 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: + JsonApiApiTokenOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['json_api_api_token_in_document'] = \ + json_api_api_token_in_document + return self.create_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + + def create_entity_attribute_hierarchies( + self, + workspace_id, + json_api_attribute_hierarchy_in_document, + **kwargs + ): + """Post 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.create_entity_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): + + 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: + JsonApiAttributeHierarchyOutDocument + 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_attribute_hierarchy_in_document'] = \ + json_api_attribute_hierarchy_in_document + return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + + def create_entity_automations( + self, + workspace_id, + json_api_automation_in_document, + **kwargs + ): + """Post 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.create_entity_automations(workspace_id, json_api_automation_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_automation_in_document (JsonApiAutomationInDocument): + + 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: + JsonApiAutomationOutDocument + 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_automation_in_document'] = \ + json_api_automation_in_document + return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) + + def create_entity_color_palettes( + self, + json_api_color_palette_in_document, + **kwargs + ): + """Post Color Pallettes # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_color_palette_in_document (JsonApiColorPaletteInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiColorPaletteOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_color_palette_in_document'] = \ + json_api_color_palette_in_document + return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + + def create_entity_computed_attributes( + self, + workspace_id, + json_api_computed_attribute_post_optional_id_document, + **kwargs + ): + """Post 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.create_entity_computed_attributes(workspace_id, json_api_computed_attribute_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_computed_attribute_post_optional_id_document (JsonApiComputedAttributePostOptionalIdDocument): + + 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: + JsonApiComputedAttributeOutDocument + 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_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_custom_user_application_settings( + self, + user_id, + json_api_custom_user_application_setting_post_optional_id_document, + **kwargs + ): + """Post a new custom application setting for the user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_custom_user_application_settings(user_id, json_api_custom_user_application_setting_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + user_id (str): + json_api_custom_user_application_setting_post_optional_id_document (JsonApiCustomUserApplicationSettingPostOptionalIdDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiCustomUserApplicationSettingOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id + kwargs['json_api_custom_user_application_setting_post_optional_id_document'] = \ + json_api_custom_user_application_setting_post_optional_id_document + return self.create_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + + def create_entity_dashboard_plugins( + self, + workspace_id, + json_api_dashboard_plugin_post_optional_id_document, + **kwargs + ): + """Post Plugins # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDashboardPluginOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ + json_api_dashboard_plugin_post_optional_id_document + return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + + def create_entity_data_sources( + self, + json_api_data_source_in_document, + **kwargs + ): + """Post Data Sources # noqa: E501 + + Data Source - represents data source for the workspace # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_data_sources(json_api_data_source_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_data_source_in_document (JsonApiDataSourceInDocument): + + Keyword Args: + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDataSourceOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_data_source_in_document'] = \ + json_api_data_source_in_document + return self.create_entity_data_sources_endpoint.call_with_http_info(**kwargs) + + def create_entity_export_definitions( + self, + workspace_id, + json_api_export_definition_post_optional_id_document, + **kwargs + ): + """Post Export Definitions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_export_definition_post_optional_id_document'] = \ + json_api_export_definition_post_optional_id_document + return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def create_entity_export_templates( + self, + json_api_export_template_post_optional_id_document, + **kwargs + ): + """Post Export Template entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportTemplateOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_export_template_post_optional_id_document'] = \ + json_api_export_template_post_optional_id_document + return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + + def create_entity_filter_contexts( + self, + workspace_id, + json_api_filter_context_post_optional_id_document, + **kwargs + ): + """Post Filter Context # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterContextOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_filter_context_post_optional_id_document'] = \ + json_api_filter_context_post_optional_id_document + return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + + def create_entity_filter_views( + self, + workspace_id, + json_api_filter_view_in_document, + **kwargs + ): + """Post Filter views # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_filter_view_in_document (JsonApiFilterViewInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiFilterViewOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_filter_view_in_document'] = \ + json_api_filter_view_in_document + return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + + def create_entity_identity_providers( + self, + json_api_identity_provider_in_document, + **kwargs + ): + """Post Identity Providers # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiIdentityProviderOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_identity_provider_in_document'] = \ + json_api_identity_provider_in_document + return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + + def create_entity_ip_allowlist_policies( + self, + json_api_ip_allowlist_policy_in_document, + **kwargs + ): + """Post IpAllowlistPolicy entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_ip_allowlist_policies(json_api_ip_allowlist_policy_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiIpAllowlistPolicyOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_ip_allowlist_policy_in_document'] = \ + json_api_ip_allowlist_policy_in_document + return self.create_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + + def create_entity_jwks( + self, + json_api_jwk_in_document, + **kwargs + ): + """Post Jwks # noqa: E501 + + Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_jwk_in_document (JsonApiJwkInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiJwkOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + + def create_entity_knowledge_recommendations( + self, + workspace_id, + json_api_knowledge_recommendation_post_optional_id_document, + **kwargs + ): + """Post Knowledge Recommendations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiKnowledgeRecommendationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ + json_api_knowledge_recommendation_post_optional_id_document + return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def create_entity_llm_providers( + self, + json_api_llm_provider_in_document, + **kwargs + ): + """Post LLM Provider entities # noqa: E501 + + LLM Provider - connection configuration for LLM services # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_llm_providers(json_api_llm_provider_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiLlmProviderOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_llm_provider_in_document'] = \ + json_api_llm_provider_in_document + return self.create_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + + def create_entity_memory_items( + self, + workspace_id, + json_api_memory_item_post_optional_id_document, + **kwargs + ): + """Post Memory Items # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_memory_item_post_optional_id_document'] = \ + json_api_memory_item_post_optional_id_document + return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) + + def create_entity_metrics( + self, + workspace_id, + json_api_metric_post_optional_id_document, + **kwargs + ): + """Post Metrics # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + 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: + JsonApiMetricOutDocument + 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_metric_post_optional_id_document'] = \ + json_api_metric_post_optional_id_document + return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) + + def create_entity_notification_channels( + self, + json_api_notification_channel_post_optional_id_document, + **kwargs + ): + """Post Notification Channel entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiNotificationChannelOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_notification_channel_post_optional_id_document'] = \ + json_api_notification_channel_post_optional_id_document + return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + + def create_entity_org_memory_items( + self, + json_api_org_memory_item_in_document, + **kwargs + ): + """Post organization Memory Item entities # noqa: E501 + + Organization-scoped AI memory item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def create_entity_organization_settings( + self, + json_api_organization_setting_in_document, + **kwargs + ): + """Post Organization Setting entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): + + 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: + JsonApiOrganizationSettingOutDocument + 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_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_parameters( + self, + workspace_id, + json_api_parameter_post_optional_id_document, + **kwargs + ): + """Post Parameters # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_parameters(workspace_id, json_api_parameter_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_parameter_post_optional_id_document (JsonApiParameterPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + 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: + JsonApiParameterOutDocument + 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_parameter_post_optional_id_document'] = \ + json_api_parameter_post_optional_id_document + return self.create_entity_parameters_endpoint.call_with_http_info(**kwargs) - def create_entity_attribute_hierarchies( + def create_entity_report_page_layouts( self, workspace_id, - json_api_attribute_hierarchy_in_document, + json_api_report_page_layout_post_optional_id_document, **kwargs ): - """Post Attribute Hierarchies # noqa: E501 + """Post Report Page Layout # 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_attribute_hierarchies(workspace_id, json_api_attribute_hierarchy_in_document, async_req=True) + >>> thread = api.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): + json_api_report_page_layout_post_optional_id_document (JsonApiReportPageLayoutPostOptionalIdDocument): 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] @@ -23839,7 +28285,7 @@ def create_entity_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23870,27 +28316,27 @@ def create_entity_attribute_hierarchies( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.create_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_page_layout_post_optional_id_document'] = \ + json_api_report_page_layout_post_optional_id_document + return self.create_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def create_entity_automations( + def create_entity_report_templates( self, workspace_id, - json_api_automation_in_document, + json_api_report_template_post_optional_id_document, **kwargs ): - """Post Automations # noqa: E501 + """Post Report 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_automations(workspace_id, json_api_automation_in_document, async_req=True) + >>> thread = api.create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): + json_api_report_template_post_optional_id_document (JsonApiReportTemplatePostOptionalIdDocument): 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] @@ -23927,7 +28373,7 @@ def create_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -23958,27 +28404,31 @@ def create_entity_automations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.create_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_template_post_optional_id_document'] = \ + json_api_report_template_post_optional_id_document + return self.create_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def create_entity_color_palettes( + def create_entity_reports( self, - json_api_color_palette_in_document, + workspace_id, + json_api_report_post_optional_id_document, **kwargs ): - """Post Color Pallettes # noqa: E501 + """Post Report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_color_palettes(json_api_color_palette_in_document, async_req=True) + >>> thread = api.create_entity_reports(workspace_id, json_api_report_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): + workspace_id (str): + json_api_report_post_optional_id_document (JsonApiReportPostOptionalIdDocument): 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 @@ -24011,7 +28461,7 @@ def create_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24040,26 +28490,27 @@ def create_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.create_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_report_post_optional_id_document'] = \ + json_api_report_post_optional_id_document + return self.create_entity_reports_endpoint.call_with_http_info(**kwargs) - def create_entity_csp_directives( + def create_entity_themes( self, - json_api_csp_directive_in_document, + json_api_theme_in_document, **kwargs ): - """Post CSP Directives # noqa: E501 + """Post Theming # 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_themes(json_api_theme_in_document, async_req=True) >>> result = thread.get() Args: - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): + json_api_theme_in_document (JsonApiThemeInDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -24094,7 +28545,7 @@ def create_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24123,29 +28574,30 @@ 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['json_api_theme_in_document'] = \ + json_api_theme_in_document + return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) - def create_entity_custom_application_settings( + def create_entity_user_data_filters( self, workspace_id, - json_api_custom_application_setting_post_optional_id_document, + json_api_user_data_filter_post_optional_id_document, **kwargs ): - """Post Custom Application Settings # noqa: E501 + """Post User Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_custom_application_settings(workspace_id, json_api_custom_application_setting_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_custom_application_setting_post_optional_id_document (JsonApiCustomApplicationSettingPostOptionalIdDocument): + json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -24179,7 +28631,7 @@ def create_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiUserDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24210,27 +28662,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) + kwargs['json_api_user_data_filter_post_optional_id_document'] = \ + json_api_user_data_filter_post_optional_id_document + return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - def create_entity_custom_geo_collections( + def create_entity_user_groups( self, - json_api_custom_geo_collection_in_document, + json_api_user_group_in_document, **kwargs ): - """Post Custom Geo Collections # noqa: E501 + """Post User Group entities # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_custom_geo_collections(json_api_custom_geo_collection_in_document, async_req=True) + >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) >>> result = thread.get() Args: - json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + json_api_user_group_in_document (JsonApiUserGroupInDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _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 @@ -24263,7 +28717,7 @@ def create_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24292,27 +28746,27 @@ def create_entity_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_custom_geo_collection_in_document'] = \ - json_api_custom_geo_collection_in_document - return self.create_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_group_in_document'] = \ + json_api_user_group_in_document + return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def create_entity_custom_user_application_settings( + def create_entity_user_settings( self, user_id, - json_api_custom_user_application_setting_post_optional_id_document, + json_api_user_setting_in_document, **kwargs ): - """Post a new custom application setting for the user # noqa: E501 + """Post new user settings for the user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_custom_user_application_settings(user_id, json_api_custom_user_application_setting_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) >>> result = thread.get() Args: user_id (str): - json_api_custom_user_application_setting_post_optional_id_document (JsonApiCustomUserApplicationSettingPostOptionalIdDocument): + json_api_user_setting_in_document (JsonApiUserSettingInDocument): Keyword Args: _return_http_data_only (bool): response data without head status @@ -24347,7 +28801,7 @@ def create_entity_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutDocument + JsonApiUserSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24378,31 +28832,29 @@ def create_entity_custom_user_application_settings( 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_user_setting_in_document'] = \ + json_api_user_setting_in_document + return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_dashboard_plugins( + def create_entity_users( self, - workspace_id, - json_api_dashboard_plugin_post_optional_id_document, + json_api_user_in_document, **kwargs ): - """Post Plugins # noqa: E501 + """Post User entities # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_dashboard_plugins(workspace_id, json_api_dashboard_plugin_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_dashboard_plugin_post_optional_id_document (JsonApiDashboardPluginPostOptionalIdDocument): + json_api_user_in_document (JsonApiUserInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - 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 @@ -24435,7 +28887,7 @@ def create_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24464,30 +28916,30 @@ def create_entity_dashboard_plugins( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_dashboard_plugin_post_optional_id_document'] = \ - json_api_dashboard_plugin_post_optional_id_document - return self.create_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_in_document'] = \ + json_api_user_in_document + return self.create_entity_users_endpoint.call_with_http_info(**kwargs) - def create_entity_data_sources( + def create_entity_visualization_objects( self, - json_api_data_source_in_document, + workspace_id, + json_api_visualization_object_post_optional_id_document, **kwargs ): - """Post Data Sources # noqa: E501 + """Post Visualization Objects # 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_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_data_source_in_document (JsonApiDataSourceInDocument): + workspace_id (str): + json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -24521,7 +28973,7 @@ def create_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiVisualizationObjectOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24550,30 +29002,31 @@ 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_visualization_object_post_optional_id_document'] = \ + json_api_visualization_object_post_optional_id_document + return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def create_entity_export_definitions( + def create_entity_workspace_color_palettes( self, workspace_id, - json_api_export_definition_post_optional_id_document, + json_api_workspace_color_palette_in_document, **kwargs ): - """Post Export Definitions # noqa: E501 + """Post Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_export_definitions(workspace_id, json_api_export_definition_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_export_definition_post_optional_id_document (JsonApiExportDefinitionPostOptionalIdDocument): + json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -24607,7 +29060,7 @@ def create_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24638,109 +29091,27 @@ def create_entity_export_definitions( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_export_definition_post_optional_id_document'] = \ - json_api_export_definition_post_optional_id_document - return self.create_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def create_entity_export_templates( - self, - json_api_export_template_post_optional_id_document, - **kwargs - ): - """Post Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_entity_export_templates(json_api_export_template_post_optional_id_document, async_req=True) - >>> result = thread.get() - - Args: - json_api_export_template_post_optional_id_document (JsonApiExportTemplatePostOptionalIdDocument): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_export_template_post_optional_id_document'] = \ - json_api_export_template_post_optional_id_document - return self.create_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_color_palette_in_document'] = \ + json_api_workspace_color_palette_in_document + return self.create_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def create_entity_filter_contexts( + def create_entity_workspace_data_filter_settings( self, workspace_id, - json_api_filter_context_post_optional_id_document, + json_api_workspace_data_filter_setting_in_document, **kwargs ): - """Post Filter Context # noqa: E501 + """Post Settings for Workspace Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_filter_contexts(workspace_id, json_api_filter_context_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_filter_context_post_optional_id_document (JsonApiFilterContextPostOptionalIdDocument): + json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -24777,7 +29148,7 @@ def create_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiWorkspaceDataFilterSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24808,30 +29179,31 @@ def create_entity_filter_contexts( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_filter_context_post_optional_id_document'] = \ - json_api_filter_context_post_optional_id_document - return self.create_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_data_filter_setting_in_document'] = \ + json_api_workspace_data_filter_setting_in_document + return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_filter_views( + def create_entity_workspace_data_filters( self, workspace_id, - json_api_filter_view_in_document, + json_api_workspace_data_filter_in_document, **kwargs ): - """Post Filter views # noqa: E501 + """Post Workspace Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_filter_views(workspace_id, json_api_filter_view_in_document, async_req=True) + >>> thread = api.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): + json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + 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 @@ -24864,7 +29236,7 @@ def create_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiWorkspaceDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24895,27 +29267,30 @@ def create_entity_filter_views( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.create_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_data_filter_in_document'] = \ + json_api_workspace_data_filter_in_document + return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def create_entity_identity_providers( + def create_entity_workspace_export_templates( self, - json_api_identity_provider_in_document, + workspace_id, + json_api_workspace_export_template_post_optional_id_document, **kwargs ): - """Post Identity Providers # noqa: E501 + """Post Workspace Export Template # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_identity_providers(json_api_identity_provider_in_document, async_req=True) + >>> thread = api.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + workspace_id (str): + json_api_workspace_export_template_post_optional_id_document (JsonApiWorkspaceExportTemplatePostOptionalIdDocument): Keyword Args: + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -24948,7 +29323,7 @@ def create_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiWorkspaceExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -24977,28 +29352,32 @@ def create_entity_identity_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.create_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_export_template_post_optional_id_document'] = \ + json_api_workspace_export_template_post_optional_id_document + return self.create_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def create_entity_ip_allowlist_policies( + def create_entity_workspace_settings( self, - json_api_ip_allowlist_policy_in_document, + workspace_id, + json_api_workspace_setting_post_optional_id_document, **kwargs ): - """Post IpAllowlistPolicy entities # noqa: E501 + """Post Settings for Workspaces # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_ip_allowlist_policies(json_api_ip_allowlist_policy_in_document, async_req=True) + >>> thread = api.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): + workspace_id (str): + json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): 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 @@ -25031,7 +29410,7 @@ def create_entity_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutDocument + JsonApiWorkspaceSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -25060,28 +29439,32 @@ def create_entity_ip_allowlist_policies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_ip_allowlist_policy_in_document'] = \ - json_api_ip_allowlist_policy_in_document - return self.create_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_setting_post_optional_id_document'] = \ + json_api_workspace_setting_post_optional_id_document + return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_jwks( + def create_entity_workspace_themes( self, - json_api_jwk_in_document, + workspace_id, + json_api_workspace_theme_in_document, **kwargs ): - """Post Jwks # noqa: E501 + """Post Workspace Theme # noqa: E501 - Creates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_jwks(json_api_jwk_in_document, async_req=True) + >>> thread = api.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, async_req=True) >>> result = thread.get() Args: - json_api_jwk_in_document (JsonApiJwkInDocument): + workspace_id (str): + json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): Keyword Args: + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -25114,7 +29497,7 @@ def create_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -25143,27 +29526,28 @@ def create_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.create_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_workspace_theme_in_document'] = \ + json_api_workspace_theme_in_document + return self.create_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def create_entity_knowledge_recommendations( + def create_entity_workspaces( self, - workspace_id, - json_api_knowledge_recommendation_post_optional_id_document, + json_api_workspace_in_document, **kwargs ): - """Post Knowledge Recommendations # noqa: E501 + """Post Workspace entities # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + json_api_workspace_in_document (JsonApiWorkspaceInDocument): Keyword Args: include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] @@ -25200,7 +29584,7 @@ def create_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiWorkspaceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -25229,28 +29613,26 @@ def create_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ - json_api_knowledge_recommendation_post_optional_id_document - return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_in_document'] = \ + json_api_workspace_in_document + return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def create_entity_llm_providers( + def delete_entity( self, - json_api_llm_provider_in_document, + id, **kwargs ): - """Post LLM Provider entities # noqa: E501 + """Delete LLM endpoint entity (Removed) # noqa: E501 - LLM Provider - connection configuration for LLM services # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_llm_providers(json_api_llm_provider_in_document, async_req=True) + >>> thread = api.delete_entity(id, async_req=True) >>> result = thread.get() Args: - json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -25285,7 +29667,7 @@ def create_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25314,31 +29696,27 @@ def create_entity_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_llm_provider_in_document'] = \ - json_api_llm_provider_in_document - return self.create_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_endpoint.call_with_http_info(**kwargs) - def create_entity_memory_items( + def delete_entity_agents( self, - workspace_id, - json_api_memory_item_post_optional_id_document, + id, **kwargs ): - """Post Memory Items # noqa: E501 + """Delete Agent 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.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_agents(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -25371,7 +29749,7 @@ def create_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25400,33 +29778,29 @@ def create_entity_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_memory_item_post_optional_id_document'] = \ - json_api_memory_item_post_optional_id_document - return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_agents_endpoint.call_with_http_info(**kwargs) - def create_entity_metrics( + def delete_entity_analytical_dashboards( self, workspace_id, - json_api_metric_post_optional_id_document, + object_id, **kwargs ): - """Post Metrics # noqa: E501 + """Delete a Dashboard # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_metrics(workspace_id, json_api_metric_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_analytical_dashboards(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_metric_post_optional_id_document (JsonApiMetricPostOptionalIdDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -25459,7 +29833,7 @@ def create_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25490,25 +29864,27 @@ def create_entity_metrics( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_metric_post_optional_id_document'] = \ - json_api_metric_post_optional_id_document - return self.create_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def create_entity_notification_channels( + def delete_entity_api_tokens( self, - json_api_notification_channel_post_optional_id_document, + user_id, + id, **kwargs ): - """Post Notification Channel entities # noqa: E501 + """Delete an API Token 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.create_entity_notification_channels(json_api_notification_channel_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_api_tokens(user_id, id, async_req=True) >>> result = thread.get() Args: - json_api_notification_channel_post_optional_id_document (JsonApiNotificationChannelPostOptionalIdDocument): + user_id (str): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -25543,7 +29919,7 @@ def create_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25572,29 +29948,31 @@ def create_entity_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_notification_channel_post_optional_id_document'] = \ - json_api_notification_channel_post_optional_id_document - return self.create_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - def create_entity_org_memory_items( + def delete_entity_attribute_hierarchies( self, - json_api_org_memory_item_in_document, + workspace_id, + object_id, **kwargs ): - """Post organization Memory Item entities # noqa: E501 + """Delete an Attribute Hierarchy # noqa: E501 - Organization-scoped AI memory item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) + >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + workspace_id (str): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _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 @@ -25627,7 +30005,7 @@ def create_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25656,25 +30034,29 @@ def create_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_org_memory_item_in_document'] = \ - json_api_org_memory_item_in_document - return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def create_entity_organization_settings( + def delete_entity_automations( self, - json_api_organization_setting_in_document, + workspace_id, + object_id, **kwargs ): - """Post Organization Setting entities # noqa: E501 + """Delete an Automation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_organization_settings(json_api_organization_setting_in_document, async_req=True) + >>> thread = api.delete_entity_automations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -25709,7 +30091,7 @@ def create_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25738,31 +30120,113 @@ def create_entity_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.create_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_automations_endpoint.call_with_http_info(**kwargs) - def create_entity_parameters( + def delete_entity_color_palettes( + self, + id, + **kwargs + ): + """Delete a Color Pallette # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_color_palettes(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + + def delete_entity_computed_attributes( self, workspace_id, - json_api_parameter_post_optional_id_document, + object_id, **kwargs ): - """Post Parameters # 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.create_entity_parameters(workspace_id, json_api_parameter_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_computed_attributes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_parameter_post_optional_id_document (JsonApiParameterPostOptionalIdDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -25795,7 +30259,7 @@ def create_entity_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25826,25 +30290,26 @@ def create_entity_parameters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_parameter_post_optional_id_document'] = \ - json_api_parameter_post_optional_id_document - return self.create_entity_parameters_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) - def create_entity_themes( + def delete_entity_csp_directives( self, - json_api_theme_in_document, + id, **kwargs ): - """Post Theming # noqa: E501 + """Delete CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_themes(json_api_theme_in_document, async_req=True) + >>> thread = api.delete_entity_csp_directives(id, async_req=True) >>> result = thread.get() Args: - json_api_theme_in_document (JsonApiThemeInDocument): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -25879,7 +30344,7 @@ def create_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25908,31 +30373,29 @@ def create_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_theme_in_document'] = \ - json_api_theme_in_document - return self.create_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def create_entity_user_data_filters( + def delete_entity_custom_application_settings( self, workspace_id, - json_api_user_data_filter_post_optional_id_document, + object_id, **kwargs ): - """Post User Data Filters # 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.create_entity_user_data_filters(workspace_id, json_api_user_data_filter_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_custom_application_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_user_data_filter_post_optional_id_document (JsonApiUserDataFilterPostOptionalIdDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -25965,7 +30428,7 @@ def create_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -25996,29 +30459,27 @@ def create_entity_user_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_user_data_filter_post_optional_id_document'] = \ - json_api_user_data_filter_post_optional_id_document - return self.create_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_user_groups( + def delete_entity_custom_geo_collections( self, - json_api_user_group_in_document, + id, **kwargs ): - """Post User Group entities # noqa: E501 + """Delete Custom Geo Collection # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_user_groups(json_api_user_group_in_document, async_req=True) + >>> thread = api.delete_entity_custom_geo_collections(id, async_req=True) >>> result = thread.get() Args: - json_api_user_group_in_document (JsonApiUserGroupInDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26051,7 +30512,7 @@ def create_entity_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26080,27 +30541,27 @@ def create_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_group_in_document'] = \ - json_api_user_group_in_document - return self.create_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def create_entity_user_settings( + def delete_entity_custom_user_application_settings( self, user_id, - json_api_user_setting_in_document, + id, **kwargs ): - """Post new user settings for the user # noqa: E501 + """Delete a custom application setting for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_user_settings(user_id, json_api_user_setting_in_document, async_req=True) + >>> thread = api.delete_entity_custom_user_application_settings(user_id, id, async_req=True) >>> result = thread.get() Args: user_id (str): - json_api_user_setting_in_document (JsonApiUserSettingInDocument): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -26135,7 +30596,7 @@ def create_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26166,29 +30627,29 @@ def create_entity_user_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['user_id'] = \ user_id - kwargs['json_api_user_setting_in_document'] = \ - json_api_user_setting_in_document - return self.create_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def create_entity_users( + def delete_entity_dashboard_plugins( self, - json_api_user_in_document, + workspace_id, + object_id, **kwargs ): - """Post User entities # noqa: E501 + """Delete a Plugin # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_users(json_api_user_in_document, async_req=True) + >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - json_api_user_in_document (JsonApiUserInDocument): + workspace_id (str): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _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 @@ -26221,7 +30682,7 @@ def create_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26250,31 +30711,30 @@ def create_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_user_in_document'] = \ - json_api_user_in_document - return self.create_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def create_entity_visualization_objects( + def delete_entity_data_sources( self, - workspace_id, - json_api_visualization_object_post_optional_id_document, + id, **kwargs ): - """Post Visualization Objects # 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.create_entity_visualization_objects(workspace_id, json_api_visualization_object_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_data_sources(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_visualization_object_post_optional_id_document (JsonApiVisualizationObjectPostOptionalIdDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26307,7 +30767,7 @@ def create_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26336,32 +30796,29 @@ def create_entity_visualization_objects( '_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_visualization_object_post_optional_id_document'] = \ - json_api_visualization_object_post_optional_id_document - return self.create_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_color_palettes( + def delete_entity_export_definitions( self, workspace_id, - json_api_workspace_color_palette_in_document, + object_id, **kwargs ): - """Post Workspace Color Palette # noqa: E501 + """Delete an Export Definition # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_workspace_color_palettes(workspace_id, json_api_workspace_color_palette_in_document, async_req=True) + >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_workspace_color_palette_in_document (JsonApiWorkspaceColorPaletteInDocument): + object_id (str): Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26394,7 +30851,7 @@ def create_entity_workspace_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceColorPaletteOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26425,31 +30882,27 @@ def create_entity_workspace_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_workspace_color_palette_in_document'] = \ - json_api_workspace_color_palette_in_document - return self.create_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_data_filter_settings( + def delete_entity_export_templates( self, - workspace_id, - json_api_workspace_data_filter_setting_in_document, + id, **kwargs ): - """Post Settings for Workspace Data Filters # 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.create_entity_workspace_data_filter_settings(workspace_id, json_api_workspace_data_filter_setting_in_document, async_req=True) + >>> thread = api.delete_entity_export_templates(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_workspace_data_filter_setting_in_document (JsonApiWorkspaceDataFilterSettingInDocument): + id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26482,7 +30935,7 @@ def create_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26511,33 +30964,29 @@ def create_entity_workspace_data_filter_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_data_filter_setting_in_document'] = \ - json_api_workspace_data_filter_setting_in_document - return self.create_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_data_filters( + def delete_entity_filter_contexts( self, workspace_id, - json_api_workspace_data_filter_in_document, + object_id, **kwargs ): - """Post Workspace Data Filters # 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.create_entity_workspace_data_filters(workspace_id, json_api_workspace_data_filter_in_document, async_req=True) + >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_workspace_data_filter_in_document (JsonApiWorkspaceDataFilterInDocument): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26570,7 +31019,7 @@ def create_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26601,30 +31050,29 @@ def create_entity_workspace_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_workspace_data_filter_in_document'] = \ - json_api_workspace_data_filter_in_document - return self.create_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_export_templates( + def delete_entity_filter_views( self, workspace_id, - json_api_workspace_export_template_post_optional_id_document, + object_id, **kwargs ): - """Post Workspace Export Template # 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.create_entity_workspace_export_templates(workspace_id, json_api_workspace_export_template_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_filter_views(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_workspace_export_template_post_optional_id_document (JsonApiWorkspaceExportTemplatePostOptionalIdDocument): + object_id (str): Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26657,7 +31105,7 @@ def create_entity_workspace_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceExportTemplateOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26688,30 +31136,27 @@ def create_entity_workspace_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_workspace_export_template_post_optional_id_document'] = \ - json_api_workspace_export_template_post_optional_id_document - return self.create_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_settings( + def delete_entity_identity_providers( self, - workspace_id, - json_api_workspace_setting_post_optional_id_document, + id, **kwargs ): - """Post Settings for Workspaces # 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.create_entity_workspace_settings(workspace_id, json_api_workspace_setting_post_optional_id_document, async_req=True) + >>> thread = api.delete_entity_identity_providers(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_workspace_setting_post_optional_id_document (JsonApiWorkspaceSettingPostOptionalIdDocument): + id (str): Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26744,7 +31189,7 @@ def create_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26773,32 +31218,27 @@ def create_entity_workspace_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['json_api_workspace_setting_post_optional_id_document'] = \ - json_api_workspace_setting_post_optional_id_document - return self.create_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def create_entity_workspace_themes( + def delete_entity_ip_allowlist_policies( self, - workspace_id, - json_api_workspace_theme_in_document, + id, **kwargs ): - """Post Workspace Theme # 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.create_entity_workspace_themes(workspace_id, json_api_workspace_theme_in_document, async_req=True) + >>> thread = api.delete_entity_ip_allowlist_policies(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - json_api_workspace_theme_in_document (JsonApiWorkspaceThemeInDocument): + id (str): Keyword Args: - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26831,7 +31271,90 @@ def create_entity_workspace_themes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceThemeOutDocument + 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_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + + def delete_entity_jwks( + self, + id, + **kwargs + ): + """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_jwks(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. """ @@ -26860,32 +31383,29 @@ def create_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['json_api_workspace_theme_in_document'] = \ - json_api_workspace_theme_in_document - return self.create_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_jwks_endpoint.call_with_http_info(**kwargs) - def create_entity_workspaces( + def delete_entity_knowledge_recommendations( self, - json_api_workspace_in_document, + workspace_id, + object_id, **kwargs ): - """Post Workspace entities # noqa: E501 + """Delete a Knowledge Recommendation # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_workspaces(json_api_workspace_in_document, async_req=True) + >>> thread = api.delete_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - json_api_workspace_in_document (JsonApiWorkspaceInDocument): + workspace_id (str): + object_id (str): Keyword Args: - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -26918,7 +31438,7 @@ def create_entity_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -26947,22 +31467,23 @@ def create_entity_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_workspace_in_document'] = \ - json_api_workspace_in_document - return self.create_entity_workspaces_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def delete_entity( + def delete_entity_llm_providers( self, id, **kwargs ): - """Delete LLM endpoint entity (Removed) # noqa: E501 + """Delete LLM Provider entity # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity(id, async_req=True) + >>> thread = api.delete_entity_llm_providers(id, async_req=True) >>> result = thread.get() Args: @@ -27032,23 +31553,25 @@ def delete_entity( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def delete_entity_agents( + def delete_entity_memory_items( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Agent 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_agents(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 @@ -27112,22 +31635,24 @@ def delete_entity_agents( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_agents_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_analytical_dashboards( + def delete_entity_metrics( self, workspace_id, object_id, **kwargs ): - """Delete a Dashboard # 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_analytical_dashboards(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_metrics(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -27200,24 +31725,22 @@ def delete_entity_analytical_dashboards( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_metrics_endpoint.call_with_http_info(**kwargs) - def delete_entity_api_tokens( + def delete_entity_notification_channels( self, - user_id, id, **kwargs ): - """Delete an API Token for a user # 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_api_tokens(user_id, id, async_req=True) + >>> thread = api.delete_entity_notification_channels(id, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): Keyword Args: @@ -27282,24 +31805,186 @@ def delete_entity_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id kwargs['id'] = \ id - return self.delete_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def delete_entity_attribute_hierarchies( + def delete_entity_org_memory_items( + self, + id, + **kwargs + ): + """Delete an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_org_memory_items(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def delete_entity_organization_settings( + self, + id, + **kwargs + ): + """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_organization_settings(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_organization_settings_endpoint.call_with_http_info(**kwargs) + + def delete_entity_parameters( self, workspace_id, object_id, **kwargs ): - """Delete an Attribute Hierarchy # noqa: E501 + """Delete a Parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_parameters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -27372,20 +32057,20 @@ 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_parameters_endpoint.call_with_http_info(**kwargs) - def delete_entity_automations( + def delete_entity_report_page_layouts( self, workspace_id, object_id, **kwargs ): - """Delete an Automation # noqa: E501 + """Delete a Report Page Layout # 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_report_page_layouts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -27458,106 +32143,25 @@ def delete_entity_automations( 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_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def delete_entity_csp_directives( + def delete_entity_report_templates( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete CSP Directives # noqa: E501 + """Delete a Report Template # 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_report_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 @@ -27621,22 +32225,24 @@ def delete_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_application_settings( + def delete_entity_reports( self, workspace_id, object_id, **kwargs ): - """Delete a Custom Application Setting # noqa: E501 + """Delete a Report # 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_reports(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -27709,19 +32315,19 @@ def delete_entity_custom_application_settings( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_reports_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_geo_collections( + def delete_entity_themes( self, id, **kwargs ): - """Delete Custom Geo Collection # noqa: E501 + """Delete Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_custom_geo_collections(id, async_req=True) + >>> thread = api.delete_entity_themes(id, async_req=True) >>> result = thread.get() Args: @@ -27791,25 +32397,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_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_custom_user_application_settings( + def delete_entity_user_data_filters( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Delete a custom application setting for a user # noqa: E501 + """Delete a User Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_custom_user_application_settings(user_id, id, async_req=True) + >>> thread = api.delete_entity_user_data_filters(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 @@ -27873,29 +32479,28 @@ 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_user_data_filters_endpoint.call_with_http_info(**kwargs) - def delete_entity_dashboard_plugins( + def delete_entity_user_groups( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete a Plugin # noqa: E501 + """Delete UserGroup entity # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_dashboard_plugins(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_user_groups(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -27959,27 +32564,26 @@ def delete_entity_dashboard_plugins( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def delete_entity_data_sources( + def delete_entity_user_settings( self, + user_id, id, **kwargs ): - """Delete Data Source entity # noqa: E501 + """Delete a setting for a user # 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_user_settings(user_id, id, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): Keyword Args: @@ -28044,27 +32648,28 @@ def delete_entity_data_sources( '_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_data_sources_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_definitions( + def delete_entity_users( self, - workspace_id, - object_id, + id, **kwargs ): - """Delete an Export Definition # noqa: E501 + """Delete User entity # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_export_definitions(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_users(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 @@ -28128,27 +32733,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_users_endpoint.call_with_http_info(**kwargs) - def delete_entity_export_templates( + def delete_entity_visualization_objects( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Export Template entity # 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_export_templates(id, async_req=True) + >>> thread = api.delete_entity_visualization_objects(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 @@ -28212,22 +32817,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_visualization_objects_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_contexts( + def delete_entity_workspace_color_palettes( self, workspace_id, object_id, **kwargs ): - """Delete a Filter Context # noqa: E501 + """Delete a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_filter_contexts(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -28300,20 +32907,20 @@ def delete_entity_filter_contexts( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_filter_views( + def delete_entity_workspace_data_filter_settings( self, workspace_id, object_id, **kwargs ): - """Delete Filter view # 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_filter_views(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: @@ -28386,23 +32993,25 @@ def delete_entity_filter_views( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_filter_views_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_identity_providers( + def delete_entity_workspace_data_filters( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Identity Provider # 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_identity_providers(id, async_req=True) + >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -28466,25 +33075,29 @@ def delete_entity_identity_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_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def delete_entity_ip_allowlist_policies( + def delete_entity_workspace_export_templates( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete IpAllowlistPolicy entity # 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_ip_allowlist_policies(id, async_req=True) + >>> thread = api.delete_entity_workspace_export_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 @@ -28548,26 +33161,29 @@ def delete_entity_ip_allowlist_policies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_jwks( + def delete_entity_workspace_settings( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete Jwk # noqa: E501 + """Delete a Setting for Workspace # noqa: E501 - Deletes JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_jwks(id, async_req=True) + >>> thread = api.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: _return_http_data_only (bool): response data without head status @@ -28631,22 +33247,24 @@ 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_workspace_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_knowledge_recommendations( + def delete_entity_workspace_themes( self, workspace_id, object_id, **kwargs ): - """Delete a Knowledge Recommendation # 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_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_workspace_themes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -28719,19 +33337,20 @@ def delete_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def delete_entity_llm_providers( + def delete_entity_workspaces( self, id, **kwargs ): - """Delete LLM Provider entity # 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_llm_providers(id, async_req=True) + >>> thread = api.delete_entity_workspaces(id, async_req=True) >>> result = thread.get() Args: @@ -28801,113 +33420,28 @@ def delete_entity_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.delete_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - - def delete_entity_memory_items( - self, - workspace_id, - object_id, - **kwargs - ): - """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_memory_items(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_memory_items_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def delete_entity_metrics( + def get_all_automations_workspace_automations( self, - workspace_id, - object_id, **kwargs ): - """Delete a Metric # 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_metrics(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 @@ -28940,7 +33474,7 @@ def delete_entity_metrics( async_req (bool): execute request asynchronously Returns: - None + JsonApiWorkspaceAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -28969,27 +33503,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) + return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) - def delete_entity_notification_channels( + def get_all_entities( self, - id, **kwargs ): - """Delete Notification Channel entity # noqa: E501 + """Get all LLM endpoint entities (Removed) # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_notification_channels(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 @@ -29053,27 +33581,28 @@ def delete_entity_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') 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.get_all_entities_endpoint.call_with_http_info(**kwargs) - def delete_entity_org_memory_items( + def get_all_entities_agents( self, - id, **kwargs ): - """Delete an organization Memory Item entity # 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.delete_entity_org_memory_items(id, async_req=True) + >>> thread = api.get_all_entities_agents(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -29106,7 +33635,7 @@ def delete_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - None + JsonApiAgentOutList If the method is called asynchronously, returns the request thread. """ @@ -29135,27 +33664,33 @@ def delete_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_agents_endpoint.call_with_http_info(**kwargs) - def delete_entity_organization_settings( + def get_all_entities_aggregated_facts( self, - id, + workspace_id, **kwargs ): - """Delete Organization Setting entity # noqa: E501 + """Get all Aggregated Facts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_organization_settings(id, async_req=True) + >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) >>> result = thread.get() Args: - 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. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -29188,7 +33723,7 @@ def delete_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - None + JsonApiAggregatedFactOutList If the method is called asynchronously, returns the request thread. """ @@ -29217,29 +33752,35 @@ 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 + return self.get_all_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def delete_entity_parameters( + def get_all_entities_analytical_dashboards( self, workspace_id, - object_id, **kwargs ): - """Delete a Parameter # 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.delete_entity_parameters(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_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 @@ -29272,7 +33813,7 @@ def delete_entity_parameters( async_req (bool): execute request asynchronously Returns: - None + JsonApiAnalyticalDashboardOutList If the method is called asynchronously, returns the request thread. """ @@ -29303,27 +33844,30 @@ def delete_entity_parameters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_parameters_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def delete_entity_themes( + def get_all_entities_api_tokens( self, - id, + user_id, **kwargs ): - """Delete Theming # 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.delete_entity_themes(id, async_req=True) + >>> thread = api.get_all_entities_api_tokens(user_id, async_req=True) >>> result = thread.get() Args: - id (str): + 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] + 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 @@ -29356,7 +33900,7 @@ def delete_entity_themes( async_req (bool): execute request asynchronously Returns: - None + JsonApiApiTokenOutList If the method is called asynchronously, returns the request thread. """ @@ -29385,29 +33929,35 @@ def delete_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_api_tokens_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_data_filters( + def get_all_entities_attribute_hierarchies( self, workspace_id, - object_id, **kwargs ): - """Delete a User Data Filter # 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.delete_entity_user_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_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 @@ -29440,7 +33990,7 @@ def delete_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - None + JsonApiAttributeHierarchyOutList If the method is called asynchronously, returns the request thread. """ @@ -29471,28 +34021,33 @@ def delete_entity_user_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_groups( + def get_all_entities_attributes( self, - id, + workspace_id, **kwargs ): - """Delete UserGroup entity # noqa: E501 + """Get all Attributes # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_groups(id, async_req=True) + >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) >>> result = thread.get() Args: - 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. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -29525,7 +34080,7 @@ def delete_entity_user_groups( async_req (bool): execute request asynchronously Returns: - None + JsonApiAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -29554,29 +34109,35 @@ def delete_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_attributes_endpoint.call_with_http_info(**kwargs) - def delete_entity_user_settings( + def get_all_entities_automations( self, - user_id, - id, + workspace_id, **kwargs ): - """Delete a setting for a user # noqa: E501 + """Get all Automations # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_user_settings(user_id, id, async_req=True) + >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) >>> result = thread.get() Args: - user_id (str): - 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. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -29609,7 +34170,7 @@ def delete_entity_user_settings( async_req (bool): execute request asynchronously Returns: - None + JsonApiAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -29638,30 +34199,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 + return self.get_all_entities_automations_endpoint.call_with_http_info(**kwargs) - def delete_entity_users( + def get_all_entities_color_palettes( self, - id, **kwargs ): - """Delete User entity # noqa: E501 + """Get all Color Pallettes # 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.get_all_entities_color_palettes(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -29694,7 +34254,7 @@ def delete_entity_users( async_req (bool): execute request asynchronously Returns: - None + JsonApiColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -29723,29 +34283,33 @@ 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) + return self.get_all_entities_color_palettes_endpoint.call_with_http_info(**kwargs) - def delete_entity_visualization_objects( + def get_all_entities_computed_attributes( self, workspace_id, - object_id, **kwargs ): - """Delete a Visualization Object # 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.delete_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_computed_attributes(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_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 @@ -29778,7 +34342,7 @@ def delete_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - None + JsonApiComputedAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -29809,29 +34373,28 @@ def delete_entity_visualization_objects( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_computed_attributes_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_color_palettes( + def get_all_entities_csp_directives( self, - workspace_id, - object_id, **kwargs ): - """Delete a Workspace Color Palette # 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.delete_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_csp_directives(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + 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 @@ -29864,7 +34427,7 @@ def delete_entity_workspace_color_palettes( async_req (bool): execute request asynchronously Returns: - None + JsonApiCspDirectiveOutList If the method is called asynchronously, returns the request thread. """ @@ -29893,31 +34456,32 @@ def delete_entity_workspace_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filter_settings( + def get_all_entities_custom_application_settings( self, workspace_id, - object_id, **kwargs ): - """Delete a Settings for Workspace Data Filter # 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.delete_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -29950,7 +34514,7 @@ def delete_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - None + JsonApiCustomApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -29981,29 +34545,27 @@ def delete_entity_workspace_data_filter_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_data_filters( + def get_all_entities_custom_geo_collections( self, - workspace_id, - object_id, **kwargs ): - """Delete a Workspace Data Filter # noqa: E501 + """Get all Custom Geo Collections # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_custom_geo_collections(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + 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 @@ -30036,7 +34598,7 @@ def delete_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - None + JsonApiCustomGeoCollectionOutList If the method is called asynchronously, returns the request thread. """ @@ -30065,31 +34627,30 @@ def delete_entity_workspace_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_export_templates( + def get_all_entities_custom_user_application_settings( self, - workspace_id, - object_id, + user_id, **kwargs ): - """Delete a Workspace Export Template # 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.delete_entity_workspace_export_templates(workspace_id, object_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): - object_id (str): + 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] + 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 @@ -30122,7 +34683,7 @@ def delete_entity_workspace_export_templates( async_req (bool): execute request asynchronously Returns: - None + JsonApiCustomUserApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -30151,31 +34712,35 @@ def delete_entity_workspace_export_templates( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_settings( + def get_all_entities_dashboard_plugins( self, workspace_id, - object_id, **kwargs ): - """Delete a Setting for Workspace # 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.delete_entity_workspace_settings(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_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 @@ -30208,7 +34773,7 @@ def delete_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - None + JsonApiDashboardPluginOutList If the method is called asynchronously, returns the request thread. """ @@ -30239,29 +34804,27 @@ def delete_entity_workspace_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - return self.delete_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspace_themes( + def get_all_entities_data_source_identifiers( self, - workspace_id, - object_id, **kwargs ): - """Delete a Workspace Theme # 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.delete_entity_workspace_themes(workspace_id, object_id, async_req=True) + >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): - object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + 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 @@ -30294,7 +34857,7 @@ def delete_entity_workspace_themes( async_req (bool): execute request asynchronously Returns: - None + JsonApiDataSourceIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -30323,30 +34886,28 @@ 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_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) - def delete_entity_workspaces( + def get_all_entities_data_sources( self, - id, **kwargs ): - """Delete Workspace entity # noqa: E501 + """Get Data Source entities # noqa: E501 - Space of the shared interest # 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_workspaces(id, async_req=True) + >>> thread = api.get_all_entities_data_sources(async_req=True) >>> result = thread.get() - Args: - id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -30379,7 +34940,7 @@ def delete_entity_workspaces( async_req (bool): execute request asynchronously Returns: - None + JsonApiDataSourceOutList If the method is called asynchronously, returns the request thread. """ @@ -30408,29 +34969,32 @@ def delete_entity_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_workspaces_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) - def get_all_automations_workspace_automations( + def get_all_entities_datasets( self, + workspace_id, **kwargs ): - """Get all Automations across all Workspaces # 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_automations_workspace_automations(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. @@ -30464,7 +35028,7 @@ def get_all_automations_workspace_automations( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceAutomationOutList + JsonApiDatasetOutList If the method is called asynchronously, returns the request thread. """ @@ -30493,23 +35057,30 @@ def get_all_automations_workspace_automations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_automations_workspace_automations_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_datasets_endpoint.call_with_http_info(**kwargs) - def get_all_entities( + def get_all_entities_entitlements( self, **kwargs ): - """Get all LLM endpoint entities (Removed) # noqa: E501 + """Get Entitlements # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities(async_req=True) + >>> thread = api.get_all_entities_entitlements(async_req=True) >>> result = thread.get() Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -30542,7 +35113,7 @@ def get_all_entities( async_req (bool): execute request asynchronously Returns: - None + JsonApiEntitlementOutList If the method is called asynchronously, returns the request thread. """ @@ -30571,27 +35142,32 @@ 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) + return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) - def get_all_entities_agents( + def get_all_entities_export_definitions( self, + workspace_id, **kwargs ): - """Get all Agent entities # noqa: E501 + """Get all Export Definitions # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_agents(async_req=True) + >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -30625,7 +35201,7 @@ def get_all_entities_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutList + JsonApiExportDefinitionOutList If the method is called asynchronously, returns the request thread. """ @@ -30654,32 +35230,28 @@ 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_export_definitions_endpoint.call_with_http_info(**kwargs) - def get_all_entities_aggregated_facts( + def get_all_entities_export_templates( self, - workspace_id, **kwargs ): - """Get all Aggregated Facts # noqa: E501 + """GET all Export Template entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_aggregated_facts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_export_templates(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. @@ -30713,7 +35285,7 @@ def get_all_entities_aggregated_facts( async_req (bool): execute request asynchronously Returns: - JsonApiAggregatedFactOutList + JsonApiExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -30742,21 +35314,19 @@ 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) + return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_analytical_dashboards( + def get_all_entities_facts( self, workspace_id, **kwargs ): - """Get all Dashboards # noqa: E501 + """Get all Facts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_analytical_dashboards(workspace_id, async_req=True) + >>> thread = api.get_all_entities_facts(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -30803,7 +35373,7 @@ def get_all_entities_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutList + JsonApiFactOutList If the method is called asynchronously, returns the request thread. """ @@ -30834,29 +35404,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_facts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_api_tokens( + def get_all_entities_filter_contexts( self, - user_id, + workspace_id, **kwargs ): - """List all api tokens for a user # noqa: E501 + """Get all 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.get_all_entities_api_tokens(user_id, async_req=True) + >>> thread = api.get_all_entities_filter_contexts(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. @@ -30890,7 +35463,7 @@ def get_all_entities_api_tokens( async_req (bool): execute request asynchronously Returns: - JsonApiApiTokenOutList + JsonApiFilterContextOutList If the method is called asynchronously, returns the request thread. """ @@ -30919,21 +35492,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_filter_contexts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attribute_hierarchies( + def get_all_entities_filter_views( self, workspace_id, **kwargs ): - """Get all Attribute Hierarchies # noqa: E501 + """Get all Filter views # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_attribute_hierarchies(workspace_id, async_req=True) + >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -30980,7 +35553,7 @@ def get_all_entities_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutList + JsonApiFilterViewOutList If the method is called asynchronously, returns the request thread. """ @@ -31011,19 +35584,19 @@ 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_filter_views_endpoint.call_with_http_info(**kwargs) - def get_all_entities_attributes( + def get_all_entities_fiscal_calendars( self, workspace_id, **kwargs ): - """Get all Attributes # noqa: E501 + """Get all Fiscal Calendars # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_attributes(workspace_id, async_req=True) + >>> thread = api.get_all_entities_fiscal_calendars(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31032,7 +35605,6 @@ def get_all_entities_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] @@ -31070,7 +35642,7 @@ def get_all_entities_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeOutList + JsonApiFiscalCalendarOutList If the method is called asynchronously, returns the request thread. """ @@ -31101,32 +35673,109 @@ def get_all_entities_attributes( 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_fiscal_calendars_endpoint.call_with_http_info(**kwargs) - def get_all_entities_automations( + def get_all_entities_identity_providers( self, - workspace_id, **kwargs ): - """Get all Automations # noqa: E501 + """Get all Identity Providers # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_automations(workspace_id, async_req=True) + >>> thread = api.get_all_entities_identity_providers(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiIdentityProviderOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_ip_allowlist_policies( + self, + **kwargs + ): + """Get all IpAllowlistPolicy entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_ip_allowlist_policies(async_req=True) >>> result = thread.get() - Args: - workspace_id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -31160,7 +35809,7 @@ def get_all_entities_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutList + JsonApiIpAllowlistPolicyOutList If the method is called asynchronously, returns the request thread. """ @@ -31189,20 +35838,19 @@ def get_all_entities_automations( '_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_automations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_color_palettes( + def get_all_entities_jwks( self, **kwargs ): - """Get all Color Pallettes # noqa: E501 + """Get all Jwks # noqa: E501 + Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_color_palettes(async_req=True) + >>> thread = api.get_all_entities_jwks(async_req=True) >>> result = thread.get() @@ -31244,7 +35892,7 @@ def get_all_entities_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutList + JsonApiJwkOutList If the method is called asynchronously, returns the request thread. """ @@ -31273,27 +35921,32 @@ 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_jwks_endpoint.call_with_http_info(**kwargs) - def get_all_entities_csp_directives( + def get_all_entities_knowledge_recommendations( self, + workspace_id, **kwargs ): - """Get CSP Directives # noqa: E501 + """Get all Knowledge Recommendations # 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_knowledge_recommendations(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. @@ -31327,7 +35980,7 @@ def get_all_entities_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutList + JsonApiKnowledgeRecommendationOutList If the method is called asynchronously, returns the request thread. """ @@ -31356,19 +36009,21 @@ def get_all_entities_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_application_settings( + def get_all_entities_labels( self, workspace_id, **kwargs ): - """Get all Custom Application Settings # noqa: E501 + """Get all Labels # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_application_settings(workspace_id, async_req=True) + >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31377,6 +36032,7 @@ def get_all_entities_custom_application_settings( Keyword Args: origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -31414,7 +36070,7 @@ def get_all_entities_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutList + JsonApiLabelOutList If the method is called asynchronously, returns the request thread. """ @@ -31445,18 +36101,18 @@ def get_all_entities_custom_application_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_geo_collections( + def get_all_entities_llm_providers( self, **kwargs ): - """Get all Custom Geo Collections # noqa: E501 + """Get all LLM Provider entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_geo_collections(async_req=True) + >>> thread = api.get_all_entities_llm_providers(async_req=True) >>> result = thread.get() @@ -31498,7 +36154,7 @@ def get_all_entities_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutList + JsonApiLlmProviderOutList If the method is called asynchronously, returns the request thread. """ @@ -31527,29 +36183,32 @@ def get_all_entities_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_custom_user_application_settings( + def get_all_entities_memory_items( self, - user_id, + workspace_id, **kwargs ): - """List all custom application settings for a user # noqa: E501 + """Get all Memory Items # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_custom_user_application_settings(user_id, async_req=True) + >>> thread = api.get_all_entities_memory_items(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. @@ -31583,7 +36242,7 @@ def get_all_entities_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutList + JsonApiMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -31612,21 +36271,21 @@ 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) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def get_all_entities_dashboard_plugins( + def get_all_entities_metrics( self, workspace_id, **kwargs ): - """Get all Plugins # noqa: E501 + """Get all Metrics # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_dashboard_plugins(workspace_id, async_req=True) + >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31673,7 +36332,7 @@ def get_all_entities_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutList + JsonApiMetricOutList If the method is called asynchronously, returns the request thread. """ @@ -31704,18 +36363,18 @@ def get_all_entities_dashboard_plugins( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_source_identifiers( + def get_all_entities_notification_channel_identifiers( self, **kwargs ): - """Get all Data Source Identifiers # noqa: E501 + """Get all Notification Channel Identifier entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_data_source_identifiers(async_req=True) + >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) >>> result = thread.get() @@ -31757,7 +36416,7 @@ def get_all_entities_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutList + JsonApiNotificationChannelIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -31786,19 +36445,18 @@ def get_all_entities_data_source_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_data_sources( + def get_all_entities_notification_channels( self, **kwargs ): - """Get Data Source entities # noqa: E501 + """Get all Notification Channel 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_data_sources(async_req=True) + >>> thread = api.get_all_entities_notification_channels(async_req=True) >>> result = thread.get() @@ -31840,7 +36498,172 @@ def get_all_entities_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutList + JsonApiNotificationChannelOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_org_memory_items( + self, + **kwargs + ): + """Get all organization Memory Item entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_org_memory_items(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_organization_settings( + self, + **kwargs + ): + """Get Organization Setting entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_organization_settings(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrganizationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -31869,19 +36692,19 @@ def get_all_entities_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_data_sources_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_datasets( + def get_all_entities_parameters( self, workspace_id, **kwargs ): - """Get all Datasets # noqa: E501 + """Get all Parameters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_datasets(workspace_id, async_req=True) + >>> thread = api.get_all_entities_parameters(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -31928,7 +36751,7 @@ def get_all_entities_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutList + JsonApiParameterOutList If the method is called asynchronously, returns the request thread. """ @@ -31959,102 +36782,19 @@ 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) - - def get_all_entities_entitlements( - self, - **kwargs - ): - """Get Entitlements # noqa: E501 - - Space of the shared interest # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_entitlements(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiEntitlementOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_entitlements_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_parameters_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_definitions( + def get_all_entities_report_page_layouts( self, workspace_id, **kwargs ): - """Get all Export Definitions # noqa: E501 + """Get all Report Page Layouts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_export_definitions(workspace_id, async_req=True) + >>> thread = api.get_all_entities_report_page_layouts(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -32101,7 +36841,7 @@ def get_all_entities_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutList + JsonApiReportPageLayoutOutList If the method is called asynchronously, returns the request thread. """ @@ -32132,101 +36872,19 @@ def get_all_entities_export_definitions( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_export_templates( - self, - **kwargs - ): - """GET all Export Template entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_export_templates(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_export_templates_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_facts( + def get_all_entities_report_templates( self, workspace_id, **kwargs ): - """Get all Facts # noqa: E501 + """Get all Report 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_facts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_report_templates(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -32273,7 +36931,7 @@ def get_all_entities_facts( async_req (bool): execute request asynchronously Returns: - JsonApiFactOutList + JsonApiReportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -32304,19 +36962,19 @@ def get_all_entities_facts( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_facts_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_report_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_filter_contexts( + def get_all_entities_reports( self, workspace_id, **kwargs ): - """Get all Filter Context # noqa: E501 + """Get all Reports # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_filter_contexts(workspace_id, async_req=True) + >>> thread = api.get_all_entities_reports(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -32363,7 +37021,7 @@ def get_all_entities_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutList + JsonApiReportOutList If the method is called asynchronously, returns the request thread. """ @@ -32394,32 +37052,26 @@ def get_all_entities_filter_contexts( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_reports_endpoint.call_with_http_info(**kwargs) - def get_all_entities_filter_views( + def get_all_entities_themes( self, - workspace_id, **kwargs ): - """Get all Filter views # noqa: E501 + """Get all Theming entities # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_filter_views(workspace_id, async_req=True) + >>> thread = api.get_all_entities_themes(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. @@ -32453,7 +37105,7 @@ def get_all_entities_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutList + JsonApiThemeOutList If the method is called asynchronously, returns the request thread. """ @@ -32482,21 +37134,19 @@ def get_all_entities_filter_views( '_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_filter_views_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_fiscal_calendars( + def get_all_entities_user_data_filters( self, workspace_id, **kwargs ): - """Get all Fiscal Calendars # noqa: E501 + """Get all User Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_fiscal_calendars(workspace_id, async_req=True) + >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -32505,6 +37155,7 @@ def get_all_entities_fiscal_calendars( 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] @@ -32542,7 +37193,7 @@ def get_all_entities_fiscal_calendars( async_req (bool): execute request asynchronously Returns: - JsonApiFiscalCalendarOutList + JsonApiUserDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -32573,23 +37224,25 @@ def get_all_entities_fiscal_calendars( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_fiscal_calendars_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) - def get_all_entities_identity_providers( + def get_all_entities_user_groups( self, **kwargs ): - """Get all Identity Providers # noqa: E501 + """Get UserGroup entities # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_identity_providers(async_req=True) + >>> thread = api.get_all_entities_user_groups(async_req=True) >>> result = thread.get() Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -32626,7 +37279,7 @@ def get_all_entities_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutList + JsonApiUserGroupOutList If the method is called asynchronously, returns the request thread. """ @@ -32655,24 +37308,24 @@ def get_all_entities_identity_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_identity_providers_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) - def get_all_entities_ip_allowlist_policies( + def get_all_entities_user_identifiers( self, **kwargs ): - """Get all IpAllowlistPolicy entities # noqa: E501 + """Get UserIdentifier entities # noqa: E501 + UserIdentifier - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_ip_allowlist_policies(async_req=True) + >>> thread = api.get_all_entities_user_identifiers(async_req=True) >>> result = thread.get() Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -32709,7 +37362,7 @@ def get_all_entities_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutList + JsonApiUserIdentifierOutList If the method is called asynchronously, returns the request thread. """ @@ -32738,21 +37391,23 @@ def get_all_entities_ip_allowlist_policies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_jwks( + def get_all_entities_user_settings( self, + user_id, **kwargs ): - """Get all Jwks # noqa: E501 + """List all settings for a user # noqa: E501 - Returns all JSON web keys - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_jwks(async_req=True) + >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) >>> result = thread.get() + Args: + user_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -32792,7 +37447,7 @@ def get_all_entities_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutList + JsonApiUserSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -32821,32 +37476,30 @@ def get_all_entities_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_knowledge_recommendations( + def get_all_entities_users( self, - workspace_id, **kwargs ): - """Get all Knowledge Recommendations # noqa: E501 + """Get User entities # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_knowledge_recommendations(workspace_id, async_req=True) + >>> thread = api.get_all_entities_users(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. @@ -32880,7 +37533,7 @@ def get_all_entities_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutList + JsonApiUserOutList If the method is called asynchronously, returns the request thread. """ @@ -32909,21 +37562,19 @@ def get_all_entities_knowledge_recommendations( '_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_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) - def get_all_entities_labels( + def get_all_entities_visualization_objects( self, workspace_id, **kwargs ): - """Get all Labels # noqa: E501 + """Get all Visualization Objects # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_labels(workspace_id, async_req=True) + >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -32970,7 +37621,7 @@ def get_all_entities_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutList + JsonApiVisualizationObjectOutList If the method is called asynchronously, returns the request thread. """ @@ -33001,26 +37652,31 @@ def get_all_entities_labels( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_labels_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - def get_all_entities_llm_providers( + def get_all_entities_workspace_color_palettes( self, + workspace_id, **kwargs ): - """Get all LLM Provider entities # noqa: E501 + """Get all Workspace Color Palettes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_llm_providers(async_req=True) + >>> thread = api.get_all_entities_workspace_color_palettes(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -33054,7 +37710,7 @@ def get_all_entities_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutList + JsonApiWorkspaceColorPaletteOutList If the method is called asynchronously, returns the request thread. """ @@ -33083,19 +37739,21 @@ def get_all_entities_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_memory_items( + def get_all_entities_workspace_data_filter_settings( self, workspace_id, **kwargs ): - """Get all Memory Items # noqa: E501 + """Get all Settings for Workspace Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_memory_items(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -33142,7 +37800,7 @@ def get_all_entities_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutList + JsonApiWorkspaceDataFilterSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -33173,19 +37831,19 @@ def get_all_entities_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_metrics( + def get_all_entities_workspace_data_filters( self, workspace_id, **kwargs ): - """Get all Metrics # noqa: E501 + """Get all Workspace Data Filters # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_metrics(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_data_filters(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -33232,7 +37890,7 @@ def get_all_entities_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutList + JsonApiWorkspaceDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -33263,191 +37921,31 @@ def get_all_entities_metrics( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_metrics_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_notification_channel_identifiers( - self, - **kwargs - ): - """Get all Notification Channel Identifier entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channel_identifiers(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelIdentifierOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - - def get_all_entities_notification_channels( - self, - **kwargs - ): - """Get all Notification Channel entities # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_all_entities_notification_channels(async_req=True) - >>> result = thread.get() - - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiNotificationChannelOutList - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def get_all_entities_org_memory_items( + def get_all_entities_workspace_export_templates( self, + workspace_id, **kwargs ): - """Get all organization Memory Item entities # noqa: E501 + """Get all Workspace Export Templates # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_org_memory_items(async_req=True) + >>> thread = api.get_all_entities_workspace_export_templates(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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. @@ -33481,7 +37979,7 @@ def get_all_entities_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutList + JsonApiWorkspaceExportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -33510,26 +38008,33 @@ def get_all_entities_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_organization_settings( + def get_all_entities_workspace_settings( self, + workspace_id, **kwargs ): - """Get Organization Setting entities # noqa: E501 + """Get all Setting for Workspaces # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_organization_settings(async_req=True) + >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] 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. @@ -33563,7 +38068,7 @@ def get_all_entities_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutList + JsonApiWorkspaceSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -33592,19 +38097,21 @@ def get_all_entities_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) - def get_all_entities_parameters( + def get_all_entities_workspace_themes( self, workspace_id, **kwargs ): - """Get all Parameters # noqa: E501 + """Get all Workspace Themes # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_parameters(workspace_id, async_req=True) + >>> thread = api.get_all_entities_workspace_themes(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -33613,7 +38120,6 @@ def get_all_entities_parameters( 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] @@ -33651,7 +38157,7 @@ def get_all_entities_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutList + JsonApiWorkspaceThemeOutList If the method is called asynchronously, returns the request thread. """ @@ -33682,23 +38188,25 @@ def get_all_entities_parameters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_parameters_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspace_themes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_themes( + def get_all_entities_workspaces( self, **kwargs ): - """Get all Theming entities # noqa: E501 + """Get Workspace entities # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_themes(async_req=True) + >>> thread = api.get_all_entities_workspaces(async_req=True) >>> result = thread.get() Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] @@ -33735,7 +38243,7 @@ def get_all_entities_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutList + JsonApiWorkspaceOutList If the method is called asynchronously, returns the request thread. """ @@ -33764,33 +38272,23 @@ def get_all_entities_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_themes_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_data_filters( + def get_all_options( self, - workspace_id, **kwargs ): - """Get all User Data Filters # noqa: E501 + """Links for all configuration options # noqa: E501 + Retrieves links for all options for different configurations. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_data_filters(workspace_id, async_req=True) + >>> thread = api.get_all_options(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 @@ -33823,7 +38321,7 @@ def get_all_entities_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutList + {str: (bool, date, datetime, dict, float, int, list, str, none_type)} If the method is called asynchronously, returns the request thread. """ @@ -33852,31 +38350,23 @@ def get_all_entities_user_data_filters( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_all_options_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_groups( + def get_data_source_drivers( self, **kwargs ): - """Get UserGroup entities # noqa: E501 + """Get all available data source drivers # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 + Retrieves a list of all supported data sources along with information about the used drivers. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_groups(async_req=True) + >>> thread = api.get_data_source_drivers(async_req=True) >>> result = thread.get() Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -33909,7 +38399,7 @@ def get_all_entities_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutList + {str: (str,)} If the method is called asynchronously, returns the request thread. """ @@ -33938,28 +38428,26 @@ def get_all_entities_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_groups_endpoint.call_with_http_info(**kwargs) + return self.get_data_source_drivers_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_identifiers( + def get_entity( self, + id, **kwargs ): - """Get UserIdentifier entities # noqa: E501 + """Get LLM endpoint entity (Removed) # noqa: E501 - UserIdentifier - represents entity interacting with platform # 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_user_identifiers(async_req=True) + >>> thread = api.get_entity(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -33992,7 +38480,7 @@ def get_all_entities_user_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiUserIdentifierOutList + None If the method is called asynchronously, returns the request thread. """ @@ -34021,30 +38509,29 @@ def get_all_entities_user_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_user_identifiers_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_endpoint.call_with_http_info(**kwargs) - def get_all_entities_user_settings( + def get_entity_agents( self, - user_id, + id, **kwargs ): - """List all settings for a user # noqa: E501 + """Get Agent entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_user_settings(user_id, async_req=True) + >>> thread = api.get_entity_agents(id, async_req=True) >>> result = thread.get() Args: - user_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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] + 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 @@ -34077,7 +38564,7 @@ def get_all_entities_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutList + JsonApiAgentOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34106,30 +38593,32 @@ def get_all_entities_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - return self.get_all_entities_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_agents_endpoint.call_with_http_info(**kwargs) - def get_all_entities_users( + def get_entity_aggregated_facts( self, + workspace_id, + object_id, **kwargs ): - """Get User entities # noqa: E501 + """Get an Aggregated Fact # noqa: E501 - User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_users(async_req=True) + >>> thread = api.get_entity_aggregated_facts(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] - 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. @@ -34163,7 +38652,7 @@ def get_all_entities_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutList + JsonApiAggregatedFactOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34192,31 +38681,33 @@ def get_all_entities_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_visualization_objects( + def get_entity_analytical_dashboards( self, workspace_id, + object_id, **kwargs ): - """Get all Visualization Objects # noqa: E501 + """Get a Dashboard # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_visualization_objects(workspace_id, async_req=True) + >>> thread = api.get_entity_analytical_dashboards(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): + object_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 @@ -34251,7 +38742,7 @@ def get_all_entities_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutList + JsonApiAnalyticalDashboardOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34282,32 +38773,30 @@ def get_all_entities_visualization_objects( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_color_palettes( + def get_entity_api_tokens( self, - workspace_id, + user_id, + id, **kwargs ): - """Get all Workspace Color Palettes # noqa: E501 + """Get an API Token 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_workspace_color_palettes(workspace_id, async_req=True) + >>> thread = api.get_entity_api_tokens(user_id, id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + user_id (str): + id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -34340,7 +38829,7 @@ def get_all_entities_workspace_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceColorPaletteOutList + JsonApiApiTokenOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34369,33 +38858,33 @@ def get_all_entities_workspace_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['user_id'] = \ + user_id + kwargs['id'] = \ + id + return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_data_filter_settings( + def get_entity_attribute_hierarchies( self, workspace_id, + object_id, **kwargs ): - """Get all Settings for Workspace Data Filters # noqa: E501 + """Get 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.get_all_entities_workspace_data_filter_settings(workspace_id, async_req=True) + >>> thread = api.get_entity_attribute_hierarchies(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): + object_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 @@ -34430,7 +38919,7 @@ def get_all_entities_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutList + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34461,31 +38950,31 @@ def get_all_entities_workspace_data_filter_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_data_filters( + def get_entity_attributes( self, workspace_id, + object_id, **kwargs ): - """Get all Workspace Data Filters # noqa: E501 + """Get an 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.get_all_entities_workspace_data_filters(workspace_id, async_req=True) + >>> thread = api.get_entity_attributes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): + object_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 @@ -34520,7 +39009,7 @@ def get_all_entities_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutList + JsonApiAttributeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34551,30 +39040,31 @@ def get_all_entities_workspace_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_attributes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_export_templates( + def get_entity_automations( self, workspace_id, + object_id, **kwargs ): - """Get all Workspace Export Templates # noqa: E501 + """Get 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.get_all_entities_workspace_export_templates(workspace_id, async_req=True) + >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): + object_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] + 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 @@ -34609,7 +39099,7 @@ def get_all_entities_workspace_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceExportTemplateOutList + JsonApiAutomationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34640,32 +39130,28 @@ def get_all_entities_workspace_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_settings( + def get_entity_color_palettes( self, - workspace_id, + id, **kwargs ): - """Get all Setting for Workspaces # noqa: E501 + """Get Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_workspace_settings(workspace_id, async_req=True) + >>> thread = api.get_entity_color_palettes(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): + id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 - size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 - sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -34698,7 +39184,7 @@ def get_all_entities_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutList + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34727,32 +39213,31 @@ def get_all_entities_workspace_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - return self.get_all_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspace_themes( + def get_entity_computed_attributes( self, workspace_id, + object_id, **kwargs ): - """Get all Workspace Themes # noqa: E501 + """Get 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.get_all_entities_workspace_themes(workspace_id, async_req=True) + >>> thread = api.get_entity_computed_attributes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): + object_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] + 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 @@ -34787,7 +39272,7 @@ def get_all_entities_workspace_themes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceThemeOutList + JsonApiComputedAttributeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34818,29 +39303,28 @@ def get_all_entities_workspace_themes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_workspace_themes_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + return self.get_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) - def get_all_entities_workspaces( + def get_entity_cookie_security_configurations( self, + id, **kwargs ): - """Get Workspace entities # noqa: E501 + """Get CookieSecurityConfiguration # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_workspaces(async_req=True) + >>> thread = api.get_entity_cookie_security_configurations(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - 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 @@ -34873,7 +39357,7 @@ def get_all_entities_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutList + JsonApiCookieSecurityConfigurationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34902,23 +39386,29 @@ def get_all_entities_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_workspaces_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - def get_all_options( + def get_entity_csp_directives( self, + id, **kwargs ): - """Links for all configuration options # noqa: E501 + """Get CSP Directives # noqa: E501 - Retrieves links for all options for different configurations. # 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_options(async_req=True) + >>> thread = api.get_entity_csp_directives(id, async_req=True) >>> result = thread.get() + Args: + id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -34951,7 +39441,7 @@ def get_all_options( async_req (bool): execute request asynchronously Returns: - {str: (bool, date, datetime, dict, float, int, list, str, none_type)} + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -34980,23 +39470,32 @@ def get_all_options( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_options_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def get_data_source_drivers( + def get_entity_custom_application_settings( self, + workspace_id, + object_id, **kwargs ): - """Get all available data source drivers # noqa: E501 + """Get a Custom Application Setting # noqa: E501 - Retrieves a list of all supported data sources along with information about the used drivers. # 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_data_source_drivers(async_req=True) + >>> thread = api.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + object_id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -35029,7 +39528,7 @@ def get_data_source_drivers( async_req (bool): execute request asynchronously Returns: - {str: (str,)} + JsonApiCustomApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35058,26 +39557,30 @@ def get_data_source_drivers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_data_source_drivers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def get_entity( + def get_entity_custom_geo_collections( self, id, **kwargs ): - """Get LLM endpoint entity (Removed) # noqa: E501 + """Get Custom Geo Collection # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity(id, async_req=True) + >>> thread = api.get_entity_custom_geo_collections(id, async_req=True) >>> result = thread.get() Args: id (str): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -35110,7 +39613,7 @@ def get_entity( async_req (bool): execute request asynchronously Returns: - None + JsonApiCustomGeoCollectionOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35141,27 +39644,28 @@ def get_entity( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_endpoint.call_with_http_info(**kwargs) + return self.get_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def get_entity_agents( + def get_entity_custom_user_application_settings( self, + user_id, id, **kwargs ): - """Get Agent entity # noqa: E501 + """Get a custom application setting for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_agents(id, async_req=True) + >>> thread = api.get_entity_custom_user_application_settings(user_id, id, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -35194,7 +39698,7 @@ def get_entity_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutDocument + JsonApiCustomUserApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35223,22 +39727,24 @@ def get_entity_agents( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - return self.get_entity_agents_endpoint.call_with_http_info(**kwargs) + return self.get_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_aggregated_facts( + def get_entity_dashboard_plugins( self, workspace_id, object_id, **kwargs ): - """Get an Aggregated Fact # noqa: E501 + """Get 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.get_entity_aggregated_facts(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35282,7 +39788,7 @@ def get_entity_aggregated_facts( async_req (bool): execute request asynchronously Returns: - JsonApiAggregatedFactOutDocument + JsonApiDashboardPluginOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35315,30 +39821,26 @@ def get_entity_aggregated_facts( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_aggregated_facts_endpoint.call_with_http_info(**kwargs) + return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def get_entity_analytical_dashboards( + def get_entity_data_source_identifiers( self, - workspace_id, - object_id, + id, **kwargs ): - """Get a Dashboard # noqa: E501 + """Get Data Source Identifier # 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_analytical_dashboards(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_data_source_identifiers(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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. @@ -35372,7 +39874,7 @@ def get_entity_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutDocument + JsonApiDataSourceIdentifierOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35401,32 +39903,30 @@ def get_entity_analytical_dashboards( '_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_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) - def get_entity_api_tokens( + def get_entity_data_sources( self, - user_id, id, **kwargs ): - """Get an API Token for a user # noqa: E501 + """Get 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.get_entity_api_tokens(user_id, id, async_req=True) + >>> thread = api.get_entity_data_sources(id, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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 @@ -35459,7 +39959,7 @@ def get_entity_api_tokens( async_req (bool): execute request asynchronously Returns: - JsonApiApiTokenOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35488,24 +39988,22 @@ def get_entity_api_tokens( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id kwargs['id'] = \ id - return self.get_entity_api_tokens_endpoint.call_with_http_info(**kwargs) + return self.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def get_entity_attribute_hierarchies( + def get_entity_datasets( self, workspace_id, object_id, **kwargs ): - """Get an Attribute Hierarchy # noqa: E501 + """Get a Dataset # 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_attribute_hierarchies(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_datasets(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35549,7 +40047,7 @@ def get_entity_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutDocument + JsonApiDatasetOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35582,31 +40080,27 @@ def get_entity_attribute_hierarchies( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) - def get_entity_attributes( + def get_entity_entitlements( self, - workspace_id, - object_id, + id, **kwargs ): - """Get an Attribute # noqa: E501 + """Get Entitlement 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.get_entity_attributes(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_entitlements(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -35639,7 +40133,7 @@ def get_entity_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeOutDocument + JsonApiEntitlementOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35668,24 +40162,22 @@ def get_entity_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.get_entity_attributes_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) - def get_entity_automations( + def get_entity_export_definitions( self, workspace_id, object_id, **kwargs ): - """Get an Automation # noqa: E501 + """Get an Export Definition # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_automations(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_export_definitions(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -35729,7 +40221,7 @@ def get_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + JsonApiExportDefinitionOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35762,19 +40254,19 @@ def get_entity_automations( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_automations_endpoint.call_with_http_info(**kwargs) + return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - def get_entity_color_palettes( + def get_entity_export_templates( self, id, **kwargs ): - """Get Color Pallette # noqa: E501 + """GET 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.get_entity_color_palettes(id, async_req=True) + >>> thread = api.get_entity_export_templates(id, async_req=True) >>> result = thread.get() Args: @@ -35814,7 +40306,7 @@ def get_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35845,26 +40337,31 @@ def get_entity_color_palettes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def get_entity_cookie_security_configurations( + def get_entity_facts( self, - id, + workspace_id, + object_id, **kwargs ): - """Get CookieSecurityConfiguration # noqa: E501 + """Get a Fact # 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_cookie_security_configurations(id, async_req=True) + >>> thread = api.get_entity_facts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -35897,7 +40394,7 @@ def get_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiFactOutDocument If the method is called asynchronously, returns the request thread. """ @@ -35926,29 +40423,35 @@ def get_entity_cookie_security_configurations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) - def get_entity_csp_directives( + def get_entity_filter_contexts( self, - id, + workspace_id, + object_id, **kwargs ): - """Get CSP Directives # noqa: E501 + """Get a Filter Context # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_csp_directives(id, async_req=True) + >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -35981,7 +40484,7 @@ def get_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiFilterContextOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36010,22 +40513,24 @@ def get_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def get_entity_custom_application_settings( + def get_entity_filter_views( self, workspace_id, object_id, **kwargs ): - """Get a Custom Application Setting # noqa: E501 + """Get 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.get_entity_custom_application_settings(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_filter_views(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -36034,8 +40539,8 @@ def get_entity_custom_application_settings( Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -36068,7 +40573,7 @@ def get_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiFilterViewOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36101,26 +40606,29 @@ def get_entity_custom_application_settings( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def get_entity_custom_geo_collections( + def get_entity_fiscal_calendars( self, - id, + workspace_id, + object_id, **kwargs ): - """Get Custom Geo Collection # noqa: E501 + """Get a Fiscal Calendar # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_custom_geo_collections(id, async_req=True) + >>> thread = api.get_entity_fiscal_calendars(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -36153,7 +40661,7 @@ def get_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiFiscalCalendarOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36182,26 +40690,26 @@ def get_entity_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_fiscal_calendars_endpoint.call_with_http_info(**kwargs) - def get_entity_custom_user_application_settings( + def get_entity_identity_providers( self, - user_id, id, **kwargs ): - """Get a custom application setting for a user # noqa: E501 + """Get 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.get_entity_custom_user_application_settings(user_id, id, async_req=True) + >>> thread = api.get_entity_identity_providers(id, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): Keyword Args: @@ -36238,7 +40746,7 @@ def get_entity_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutDocument + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36267,35 +40775,29 @@ def get_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.get_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def get_entity_dashboard_plugins( + def get_entity_ip_allowlist_policies( self, - workspace_id, - object_id, + id, **kwargs ): - """Get a Plugin # noqa: E501 + """Get 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.get_entity_dashboard_plugins(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_ip_allowlist_policies(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] 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 @@ -36328,7 +40830,7 @@ def get_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiIpAllowlistPolicyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36357,23 +40859,22 @@ def get_entity_dashboard_plugins( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def get_entity_data_source_identifiers( + def get_entity_jwks( self, id, **kwargs ): - """Get Data Source Identifier # noqa: E501 + """Get Jwk # noqa: E501 + Returns 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.get_entity_data_source_identifiers(id, async_req=True) + >>> thread = api.get_entity_jwks(id, async_req=True) >>> result = thread.get() Args: @@ -36381,7 +40882,6 @@ def get_entity_data_source_identifiers( 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] - 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 @@ -36414,7 +40914,7 @@ def get_entity_data_source_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceIdentifierOutDocument + JsonApiJwkOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36445,27 +40945,30 @@ def get_entity_data_source_identifiers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_data_source_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) - def get_entity_data_sources( + def get_entity_knowledge_recommendations( self, - id, + workspace_id, + object_id, **kwargs ): - """Get Data Source entity # noqa: E501 + """Get a Knowledge Recommendation # 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_entity_data_sources(id, async_req=True) + >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -36499,7 +41002,7 @@ def get_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36528,22 +41031,24 @@ def get_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.get_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def get_entity_datasets( + def get_entity_labels( self, workspace_id, object_id, **kwargs ): - """Get a Dataset # noqa: E501 + """Get a Label # 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_datasets(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_labels(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -36587,7 +41092,7 @@ def get_entity_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutDocument + JsonApiLabelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36620,20 +41125,19 @@ def get_entity_datasets( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_datasets_endpoint.call_with_http_info(**kwargs) + return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) - def get_entity_entitlements( + def get_entity_llm_providers( self, id, **kwargs ): - """Get Entitlement entity # noqa: E501 + """Get LLM Provider 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.get_entity_entitlements(id, async_req=True) + >>> thread = api.get_entity_llm_providers(id, async_req=True) >>> result = thread.get() Args: @@ -36673,7 +41177,7 @@ def get_entity_entitlements( async_req (bool): execute request asynchronously Returns: - JsonApiEntitlementOutDocument + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36704,20 +41208,20 @@ def get_entity_entitlements( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_entitlements_endpoint.call_with_http_info(**kwargs) + return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def get_entity_export_definitions( + def get_entity_memory_items( self, workspace_id, object_id, **kwargs ): - """Get an Export Definition # noqa: E501 + """Get 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.get_entity_export_definitions(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_memory_items(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -36761,7 +41265,7 @@ def get_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36794,103 +41298,20 @@ def get_entity_export_definitions( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - - def get_entity_export_templates( - self, - id, - **kwargs - ): - """GET 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.get_entity_export_templates(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiExportTemplateOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_export_templates_endpoint.call_with_http_info(**kwargs) + return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def get_entity_facts( + def get_entity_metrics( self, workspace_id, object_id, **kwargs ): - """Get a Fact # noqa: E501 + """Get 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.get_entity_facts(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -36934,7 +41355,7 @@ def get_entity_facts( async_req (bool): execute request asynchronously Returns: - JsonApiFactOutDocument + JsonApiMetricOutDocument If the method is called asynchronously, returns the request thread. """ @@ -36967,31 +41388,26 @@ def get_entity_facts( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_facts_endpoint.call_with_http_info(**kwargs) + return self.get_entity_metrics_endpoint.call_with_http_info(**kwargs) - def get_entity_filter_contexts( + def get_entity_notification_channel_identifiers( self, - workspace_id, - object_id, + id, **kwargs ): - """Get a Filter Context # noqa: E501 + """Get Notification Channel Identifier entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_filter_contexts(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -37024,7 +41440,7 @@ def get_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiNotificationChannelIdentifierOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37053,34 +41469,28 @@ def get_entity_filter_contexts( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) - def get_entity_filter_views( + def get_entity_notification_channels( self, - workspace_id, - object_id, + id, **kwargs ): - """Get Filter view # noqa: E501 + """Get 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.get_entity_filter_views(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_notification_channels(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 _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 @@ -37113,7 +41523,7 @@ def get_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37142,33 +41552,29 @@ def get_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.get_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def get_entity_fiscal_calendars( + def get_entity_org_memory_items( self, - workspace_id, - object_id, + id, **kwargs ): - """Get a Fiscal Calendar # noqa: E501 + """Get an organization Memory Item entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_fiscal_calendars(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_org_memory_items(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + 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 @@ -37201,7 +41607,7 @@ def get_entity_fiscal_calendars( async_req (bool): execute request asynchronously Returns: - JsonApiFiscalCalendarOutDocument + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37230,23 +41636,21 @@ def get_entity_fiscal_calendars( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_fiscal_calendars_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def get_entity_identity_providers( + def get_entity_organization_settings( self, id, **kwargs ): - """Get Identity Provider # noqa: E501 + """Get 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.get_entity_identity_providers(id, async_req=True) + >>> thread = api.get_entity_organization_settings(id, async_req=True) >>> result = thread.get() Args: @@ -37286,7 +41690,7 @@ def get_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37317,19 +41721,19 @@ def get_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_ip_allowlist_policies( + def get_entity_organizations( self, id, **kwargs ): - """Get IpAllowlistPolicy entity # noqa: E501 + """Get Organizations # 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_ip_allowlist_policies(id, async_req=True) + >>> thread = api.get_entity_organizations(id, async_req=True) >>> result = thread.get() Args: @@ -37338,6 +41742,7 @@ def get_entity_ip_allowlist_policies( 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] + 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 @@ -37370,7 +41775,7 @@ def get_entity_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutDocument + JsonApiOrganizationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37401,27 +41806,31 @@ def get_entity_ip_allowlist_policies( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + return self.get_entity_organizations_endpoint.call_with_http_info(**kwargs) - def get_entity_jwks( + def get_entity_parameters( self, - id, + workspace_id, + object_id, **kwargs ): - """Get Jwk # noqa: E501 + """Get a Parameter # noqa: E501 - Returns 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.get_entity_jwks(id, async_req=True) + >>> thread = api.get_entity_parameters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -37454,7 +41863,7 @@ def get_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiParameterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37483,22 +41892,24 @@ def get_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_parameters_endpoint.call_with_http_info(**kwargs) - def get_entity_knowledge_recommendations( + def get_entity_report_page_layouts( self, workspace_id, object_id, **kwargs ): - """Get a Knowledge Recommendation # noqa: E501 + """Get a Report Page Layout # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_report_page_layouts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -37542,7 +41953,7 @@ def get_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37575,20 +41986,20 @@ def get_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def get_entity_labels( + def get_entity_report_templates( self, workspace_id, object_id, **kwargs ): - """Get a Label # noqa: E501 + """Get a Report 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_labels(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_report_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -37632,7 +42043,7 @@ def get_entity_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37665,19 +42076,109 @@ def get_entity_labels( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_labels_endpoint.call_with_http_info(**kwargs) + return self.get_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def get_entity_llm_providers( + def get_entity_reports( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Report # 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_reports(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: + JsonApiReportOutDocument + 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_reports_endpoint.call_with_http_info(**kwargs) + + def get_entity_themes( self, id, **kwargs ): - """Get LLM Provider entity # noqa: E501 + """Get Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_llm_providers(id, async_req=True) + >>> thread = api.get_entity_themes(id, async_req=True) >>> result = thread.get() Args: @@ -37717,7 +42218,7 @@ def get_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37748,20 +42249,20 @@ def get_entity_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) - def get_entity_memory_items( + def get_entity_user_data_filters( self, workspace_id, object_id, **kwargs ): - """Get a Memory Item # noqa: E501 + """Get a User Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -37805,7 +42306,7 @@ def get_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiUserDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37838,31 +42339,28 @@ def get_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - def get_entity_metrics( + def get_entity_user_groups( self, - workspace_id, - object_id, + id, **kwargs ): - """Get a Metric # noqa: E501 + """Get UserGroup entity # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_metrics(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_user_groups(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] 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 @@ -37895,7 +42393,7 @@ def get_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -37924,23 +42422,22 @@ def get_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.get_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def get_entity_notification_channel_identifiers( + def get_entity_user_identifiers( self, id, **kwargs ): - """Get Notification Channel Identifier entity # noqa: E501 + """Get UserIdentifier entity # noqa: E501 + UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_notification_channel_identifiers(id, async_req=True) + >>> thread = api.get_entity_user_identifiers(id, async_req=True) >>> result = thread.get() Args: @@ -37980,7 +42477,7 @@ def get_entity_notification_channel_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelIdentifierOutDocument + JsonApiUserIdentifierOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38011,22 +42508,24 @@ def get_entity_notification_channel_identifiers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_notification_channel_identifiers_endpoint.call_with_http_info(**kwargs) + return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) - def get_entity_notification_channels( + def get_entity_user_settings( self, + user_id, id, **kwargs ): - """Get Notification Channel entity # noqa: E501 + """Get a setting for a user # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_notification_channels(id, async_req=True) + >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): Keyword Args: @@ -38063,7 +42562,7 @@ def get_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutDocument + JsonApiUserSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38092,21 +42591,24 @@ def get_entity_notification_channels( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - return self.get_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_org_memory_items( + def get_entity_users( self, id, **kwargs ): - """Get an organization Memory Item entity # noqa: E501 + """Get User entity # noqa: E501 + User - represents entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_org_memory_items(id, async_req=True) + >>> thread = api.get_entity_users(id, async_req=True) >>> result = thread.get() Args: @@ -38147,90 +42649,7 @@ def get_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - - def get_entity_organization_settings( - self, - id, - **kwargs - ): - """Get 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.get_entity_organization_settings(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - 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: - JsonApiOrganizationSettingOutDocument + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38261,27 +42680,30 @@ def get_entity_organization_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + return self.get_entity_users_endpoint.call_with_http_info(**kwargs) - def get_entity_organizations( + def get_entity_visualization_objects( self, - id, + workspace_id, + object_id, **kwargs ): - """Get Organizations # noqa: E501 + """Get a Visualization Object # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_organizations(id, async_req=True) + >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. @@ -38315,7 +42737,7 @@ def get_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + JsonApiVisualizationObjectOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38344,22 +42766,24 @@ 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['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def get_entity_parameters( + def get_entity_workspace_color_palettes( self, workspace_id, object_id, **kwargs ): - """Get a Parameter # noqa: E501 + """Get a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_parameters(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -38368,7 +42792,6 @@ def get_entity_parameters( 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 @@ -38403,7 +42826,7 @@ def get_entity_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38436,26 +42859,31 @@ def get_entity_parameters( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_parameters_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_entity_themes( + def get_entity_workspace_data_filter_settings( self, - id, + workspace_id, + object_id, **kwargs ): - """Get Theming # noqa: E501 + """Get a Setting 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.get_entity_themes(id, async_req=True) + >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -38488,7 +42916,7 @@ def get_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiWorkspaceDataFilterSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38517,22 +42945,24 @@ def get_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_user_data_filters( + def get_entity_workspace_data_filters( self, workspace_id, object_id, **kwargs ): - """Get a User Data Filter # noqa: E501 + """Get a Workspace Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -38576,7 +43006,7 @@ def get_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutDocument + JsonApiWorkspaceDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38609,28 +43039,30 @@ def get_entity_user_data_filters( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def get_entity_user_groups( + def get_entity_workspace_export_templates( self, - id, + workspace_id, + object_id, **kwargs ): - """Get UserGroup entity # noqa: E501 + """Get a Workspace Export Template # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_groups(id, async_req=True) + >>> thread = api.get_entity_workspace_export_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -38663,7 +43095,7 @@ def get_entity_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutDocument + JsonApiWorkspaceExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38692,29 +43124,34 @@ def get_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def get_entity_user_identifiers( + def get_entity_workspace_settings( self, - id, + workspace_id, + object_id, **kwargs ): - """Get UserIdentifier entity # noqa: E501 + """Get a Setting for Workspace # noqa: E501 - UserIdentifier - represents basic information about entity interacting with platform # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_identifiers(id, async_req=True) + >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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 @@ -38747,7 +43184,7 @@ def get_entity_user_identifiers( async_req (bool): execute request asynchronously Returns: - JsonApiUserIdentifierOutDocument + JsonApiWorkspaceSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38776,30 +43213,34 @@ def get_entity_user_identifiers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_user_identifiers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def get_entity_user_settings( + def get_entity_workspace_themes( self, - user_id, - id, + workspace_id, + object_id, **kwargs ): - """Get a setting for a user # noqa: E501 + """Get a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_user_settings(user_id, id, async_req=True) + >>> thread = api.get_entity_workspace_themes(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: - user_id (str): - id (str): + workspace_id (str): + object_id (str): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -38832,7 +43273,7 @@ def get_entity_user_settings( async_req (bool): execute request asynchronously Returns: - JsonApiUserSettingOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38861,24 +43302,24 @@ def get_entity_user_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id - kwargs['id'] = \ - id - return self.get_entity_user_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def get_entity_users( + def get_entity_workspaces( self, id, **kwargs ): - """Get User entity # noqa: E501 + """Get Workspace entity # noqa: E501 - User - represents entity interacting with platform # noqa: E501 + Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_users(id, async_req=True) + >>> thread = api.get_entity_workspaces(id, async_req=True) >>> result = thread.get() Args: @@ -38887,6 +43328,7 @@ def get_entity_users( 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] + 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 @@ -38919,7 +43361,7 @@ def get_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + JsonApiWorkspaceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -38950,31 +43392,24 @@ def get_entity_users( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_users_endpoint.call_with_http_info(**kwargs) + return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def get_entity_visualization_objects( + def get_organization( self, - workspace_id, - object_id, **kwargs ): - """Get a Visualization Object # noqa: E501 + """Get current organization info # noqa: E501 + Gets a basic information about organization. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_visualization_objects(workspace_id, object_id, async_req=True) + >>> thread = api.get_organization(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] + meta_include ([str]): Return list of permissions available to logged user.. [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 @@ -39007,7 +43442,7 @@ def get_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -39036,34 +43471,26 @@ def get_entity_visualization_objects( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + return self.get_organization_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_color_palettes( + def patch_entity( self, - workspace_id, - object_id, + id, **kwargs ): - """Get a Workspace Color Palette # noqa: E501 + """Patch LLM endpoint entity (Removed) # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_color_palettes(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -39096,7 +43523,7 @@ def get_entity_workspace_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceColorPaletteOutDocument + None If the method is called asynchronously, returns the request thread. """ @@ -39125,35 +43552,31 @@ def get_entity_workspace_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.patch_entity_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_data_filter_settings( + def patch_entity_agents( self, - workspace_id, - object_id, + id, + json_api_agent_patch_document, **kwargs ): - """Get a Setting for Workspace Data Filter # noqa: E501 + """Patch Agent entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_data_filter_settings(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity_agents(id, json_api_agent_patch_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): + id (str): + json_api_agent_patch_document (JsonApiAgentPatchDocument): 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 @@ -39186,7 +43609,7 @@ def get_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + JsonApiAgentOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39215,35 +43638,35 @@ def get_entity_workspace_data_filter_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - return self.get_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_agent_patch_document'] = \ + json_api_agent_patch_document + return self.patch_entity_agents_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_data_filters( + def patch_entity_analytical_dashboards( self, workspace_id, object_id, + json_api_analytical_dashboard_patch_document, **kwargs ): - """Get a Workspace Data Filter # noqa: E501 + """Patch a Dashboard # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_data_filters(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): + json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): 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 @@ -39276,7 +43699,7 @@ def get_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + JsonApiAnalyticalDashboardOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39309,30 +43732,33 @@ def get_entity_workspace_data_filters( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_analytical_dashboard_patch_document'] = \ + json_api_analytical_dashboard_patch_document + return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_export_templates( + def patch_entity_attribute_hierarchies( self, workspace_id, object_id, + json_api_attribute_hierarchy_patch_document, **kwargs ): - """Get a Workspace Export Template # noqa: E501 + """Patch 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.get_entity_workspace_export_templates(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): + json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] + 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 @@ -39365,7 +43791,7 @@ def get_entity_workspace_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceExportTemplateOutDocument + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39398,30 +43824,33 @@ def get_entity_workspace_export_templates( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_attribute_hierarchy_patch_document'] = \ + json_api_attribute_hierarchy_patch_document + return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_settings( + def patch_entity_attributes( self, workspace_id, object_id, + json_api_attribute_patch_document, **kwargs ): - """Get a Setting for Workspace # noqa: E501 + """Patch an Attribute (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspace_settings(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): + json_api_attribute_patch_document (JsonApiAttributePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] + 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 @@ -39454,7 +43883,7 @@ def get_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + JsonApiAttributeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39487,30 +43916,33 @@ def get_entity_workspace_settings( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_attribute_patch_document'] = \ + json_api_attribute_patch_document + return self.patch_entity_attributes_endpoint.call_with_http_info(**kwargs) - def get_entity_workspace_themes( + def patch_entity_automations( self, workspace_id, object_id, + json_api_automation_patch_document, **kwargs ): - """Get a Workspace Theme # noqa: E501 + """Patch 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.get_entity_workspace_themes(workspace_id, object_id, async_req=True) + >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): + json_api_automation_patch_document (JsonApiAutomationPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False - meta_include ([str]): Include Meta objects.. [optional] + 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 @@ -39543,7 +43975,7 @@ def get_entity_workspace_themes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceThemeOutDocument + JsonApiAutomationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39576,29 +44008,30 @@ def get_entity_workspace_themes( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_automation_patch_document'] = \ + json_api_automation_patch_document + return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) - def get_entity_workspaces( + def patch_entity_color_palettes( self, id, + json_api_color_palette_patch_document, **kwargs ): - """Get Workspace entity # noqa: E501 + """Patch Color Pallette # noqa: E501 - Space of the shared interest # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_workspaces(id, async_req=True) + >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) >>> result = thread.get() Args: id (str): + json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -39631,7 +44064,7 @@ def get_entity_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutDocument + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39662,24 +44095,33 @@ def get_entity_workspaces( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.get_entity_workspaces_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_color_palette_patch_document'] = \ + json_api_color_palette_patch_document + return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def get_organization( + def patch_entity_computed_attributes( self, + workspace_id, + object_id, + json_api_computed_attribute_patch_document, **kwargs ): - """Get current organization info # noqa: E501 + """Patch a Computed Attribute # noqa: E501 - Gets a basic information about organization. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_organization(async_req=True) + >>> thread = api.patch_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_patch_document, async_req=True) >>> result = thread.get() + Args: + workspace_id (str): + object_id (str): + json_api_computed_attribute_patch_document (JsonApiComputedAttributePatchDocument): Keyword Args: - meta_include ([str]): Return list of permissions available to logged user.. [optional] + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 @@ -39712,7 +44154,7 @@ def get_organization( async_req (bool): execute request asynchronously Returns: - None + JsonApiComputedAttributeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39741,26 +44183,34 @@ def get_organization( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_organization_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_computed_attribute_patch_document'] = \ + json_api_computed_attribute_patch_document + return self.patch_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) - def patch_entity( + def patch_entity_cookie_security_configurations( self, id, + json_api_cookie_security_configuration_patch_document, **kwargs ): - """Patch LLM endpoint entity (Removed) # noqa: E501 + """Patch CookieSecurityConfiguration # 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.patch_entity(id, async_req=True) + >>> thread = api.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) >>> result = thread.get() Args: id (str): + json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -39793,7 +44243,7 @@ def patch_entity( async_req (bool): execute request asynchronously Returns: - None + JsonApiCookieSecurityConfigurationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39824,29 +44274,31 @@ def patch_entity( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - return self.patch_entity_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_cookie_security_configuration_patch_document'] = \ + json_api_cookie_security_configuration_patch_document + return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - def patch_entity_agents( + def patch_entity_csp_directives( self, id, - json_api_agent_patch_document, + json_api_csp_directive_patch_document, **kwargs ): - """Patch Agent entity # noqa: E501 + """Patch 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.patch_entity_agents(id, json_api_agent_patch_document, async_req=True) + >>> thread = api.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_agent_patch_document (JsonApiAgentPatchDocument): + json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): 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 @@ -39879,7 +44331,7 @@ def patch_entity_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutDocument + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -39910,33 +44362,32 @@ def patch_entity_agents( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_agent_patch_document'] = \ - json_api_agent_patch_document - return self.patch_entity_agents_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_csp_directive_patch_document'] = \ + json_api_csp_directive_patch_document + return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def patch_entity_analytical_dashboards( + def patch_entity_custom_application_settings( self, workspace_id, object_id, - json_api_analytical_dashboard_patch_document, + json_api_custom_application_setting_patch_document, **kwargs ): - """Patch a Dashboard # noqa: E501 + """Patch 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.patch_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_patch_document, async_req=True) + >>> thread = api.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_analytical_dashboard_patch_document (JsonApiAnalyticalDashboardPatchDocument): + json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): 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 @@ -39969,7 +44420,7 @@ def patch_entity_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutDocument + JsonApiCustomApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40002,33 +44453,30 @@ def patch_entity_analytical_dashboards( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_analytical_dashboard_patch_document'] = \ - json_api_analytical_dashboard_patch_document - return self.patch_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_custom_application_setting_patch_document'] = \ + json_api_custom_application_setting_patch_document + return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def patch_entity_attribute_hierarchies( + def patch_entity_custom_geo_collections( self, - workspace_id, - object_id, - json_api_attribute_hierarchy_patch_document, + id, + json_api_custom_geo_collection_patch_document, **kwargs ): - """Patch an Attribute Hierarchy # noqa: E501 + """Patch 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.patch_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_patch_document, async_req=True) + >>> thread = api.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_patch_document (JsonApiAttributeHierarchyPatchDocument): + id (str): + json_api_custom_geo_collection_patch_document (JsonApiCustomGeoCollectionPatchDocument): 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 @@ -40061,7 +44509,7 @@ def patch_entity_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutDocument + JsonApiCustomGeoCollectionOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40090,33 +44538,31 @@ def patch_entity_attribute_hierarchies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_patch_document'] = \ - json_api_attribute_hierarchy_patch_document - return self.patch_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_custom_geo_collection_patch_document'] = \ + json_api_custom_geo_collection_patch_document + return self.patch_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def patch_entity_attributes( + def patch_entity_dashboard_plugins( self, workspace_id, object_id, - json_api_attribute_patch_document, + json_api_dashboard_plugin_patch_document, **kwargs ): - """Patch an Attribute (beta) # noqa: E501 + """Patch 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.patch_entity_attributes(workspace_id, object_id, json_api_attribute_patch_document, async_req=True) + >>> thread = api.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_attribute_patch_document (JsonApiAttributePatchDocument): + json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): 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] @@ -40153,7 +44599,7 @@ def patch_entity_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeOutDocument + JsonApiDashboardPluginOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40186,29 +44632,117 @@ def patch_entity_attributes( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_attribute_patch_document'] = \ - json_api_attribute_patch_document - return self.patch_entity_attributes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_dashboard_plugin_patch_document'] = \ + json_api_dashboard_plugin_patch_document + return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def patch_entity_automations( + def patch_entity_data_sources( + self, + id, + json_api_data_source_patch_document, + **kwargs + ): + """Patch 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.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiDataSourceOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_data_source_patch_document'] = \ + json_api_data_source_patch_document + return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) + + def patch_entity_datasets( self, workspace_id, object_id, - json_api_automation_patch_document, + json_api_dataset_patch_document, **kwargs ): - """Patch an Automation # noqa: E501 + """Patch a Dataset (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_automations(workspace_id, object_id, json_api_automation_patch_document, async_req=True) + >>> thread = api.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_automation_patch_document (JsonApiAutomationPatchDocument): + json_api_dataset_patch_document (JsonApiDatasetPatchDocument): 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] @@ -40245,7 +44779,7 @@ def patch_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + JsonApiDatasetOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40278,30 +44812,33 @@ def patch_entity_automations( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_automation_patch_document'] = \ - json_api_automation_patch_document - return self.patch_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_dataset_patch_document'] = \ + json_api_dataset_patch_document + return self.patch_entity_datasets_endpoint.call_with_http_info(**kwargs) - def patch_entity_color_palettes( + def patch_entity_export_definitions( self, - id, - json_api_color_palette_patch_document, + workspace_id, + object_id, + json_api_export_definition_patch_document, **kwargs ): - """Patch Color Pallette # noqa: E501 + """Patch an Export Definition # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_color_palettes(id, json_api_color_palette_patch_document, async_req=True) + >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_color_palette_patch_document (JsonApiColorPalettePatchDocument): + workspace_id (str): + object_id (str): + json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): 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 @@ -40334,7 +44871,7 @@ def patch_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiExportDefinitionOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40363,29 +44900,31 @@ def patch_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_patch_document'] = \ - json_api_color_palette_patch_document - return self.patch_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_export_definition_patch_document'] = \ + json_api_export_definition_patch_document + return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) - def patch_entity_cookie_security_configurations( + def patch_entity_export_templates( self, id, - json_api_cookie_security_configuration_patch_document, + json_api_export_template_patch_document, **kwargs ): - """Patch CookieSecurityConfiguration # noqa: E501 + """Patch 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.patch_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_patch_document, async_req=True) + >>> thread = api.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_cookie_security_configuration_patch_document (JsonApiCookieSecurityConfigurationPatchDocument): + json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): 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] @@ -40421,7 +44960,7 @@ def patch_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40452,31 +44991,33 @@ def patch_entity_cookie_security_configurations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_cookie_security_configuration_patch_document'] = \ - json_api_cookie_security_configuration_patch_document - return self.patch_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_export_template_patch_document'] = \ + json_api_export_template_patch_document + return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def patch_entity_csp_directives( + def patch_entity_facts( self, - id, - json_api_csp_directive_patch_document, + workspace_id, + object_id, + json_api_fact_patch_document, **kwargs ): - """Patch CSP Directives # noqa: E501 + """Patch a Fact (beta) # 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.patch_entity_csp_directives(id, json_api_csp_directive_patch_document, async_req=True) + >>> thread = api.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_csp_directive_patch_document (JsonApiCspDirectivePatchDocument): + workspace_id (str): + object_id (str): + json_api_fact_patch_document (JsonApiFactPatchDocument): 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 @@ -40509,7 +45050,7 @@ def patch_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiFactOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40538,34 +45079,37 @@ def patch_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_csp_directive_patch_document'] = \ - json_api_csp_directive_patch_document - return self.patch_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_fact_patch_document'] = \ + json_api_fact_patch_document + return self.patch_entity_facts_endpoint.call_with_http_info(**kwargs) - def patch_entity_custom_application_settings( + def patch_entity_filter_contexts( self, workspace_id, object_id, - json_api_custom_application_setting_patch_document, + json_api_filter_context_patch_document, **kwargs ): - """Patch a Custom Application Setting # noqa: E501 + """Patch 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.patch_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_patch_document, async_req=True) + >>> thread = api.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_custom_application_setting_patch_document (JsonApiCustomApplicationSettingPatchDocument): + json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): 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 @@ -40598,7 +45142,7 @@ def patch_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiFilterContextOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40631,30 +45175,33 @@ def patch_entity_custom_application_settings( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_custom_application_setting_patch_document'] = \ - json_api_custom_application_setting_patch_document - return self.patch_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_filter_context_patch_document'] = \ + json_api_filter_context_patch_document + return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def patch_entity_custom_geo_collections( + def patch_entity_filter_views( self, - id, - json_api_custom_geo_collection_patch_document, + workspace_id, + object_id, + json_api_filter_view_patch_document, **kwargs ): - """Patch Custom Geo Collection # noqa: E501 + """Patch 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.patch_entity_custom_geo_collections(id, json_api_custom_geo_collection_patch_document, async_req=True) + >>> thread = api.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_custom_geo_collection_patch_document (JsonApiCustomGeoCollectionPatchDocument): + workspace_id (str): + object_id (str): + json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): 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 @@ -40687,7 +45234,7 @@ def patch_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiFilterViewOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40716,35 +45263,34 @@ def patch_entity_custom_geo_collections( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_custom_geo_collection_patch_document'] = \ - json_api_custom_geo_collection_patch_document - return self.patch_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_view_patch_document'] = \ + json_api_filter_view_patch_document + return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def patch_entity_dashboard_plugins( + def patch_entity_identity_providers( self, - workspace_id, - object_id, - json_api_dashboard_plugin_patch_document, + id, + json_api_identity_provider_patch_document, **kwargs ): - """Patch a Plugin # noqa: E501 + """Patch 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.patch_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_patch_document, async_req=True) + >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_dashboard_plugin_patch_document (JsonApiDashboardPluginPatchDocument): + id (str): + json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): 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 @@ -40777,7 +45323,7 @@ def patch_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40806,32 +45352,30 @@ def patch_entity_dashboard_plugins( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_dashboard_plugin_patch_document'] = \ - json_api_dashboard_plugin_patch_document - return self.patch_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_identity_provider_patch_document'] = \ + json_api_identity_provider_patch_document + return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def patch_entity_data_sources( + def patch_entity_jwks( self, id, - json_api_data_source_patch_document, + json_api_jwk_patch_document, **kwargs ): - """Patch Data Source entity # noqa: E501 + """Patch Jwk # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 + Patches 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.patch_entity_data_sources(id, json_api_data_source_patch_document, async_req=True) + >>> thread = api.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_data_source_patch_document (JsonApiDataSourcePatchDocument): + json_api_jwk_patch_document (JsonApiJwkPatchDocument): 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] @@ -40867,7 +45411,7 @@ def patch_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiJwkOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40898,29 +45442,29 @@ def patch_entity_data_sources( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_data_source_patch_document'] = \ - json_api_data_source_patch_document - return self.patch_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_jwk_patch_document'] = \ + json_api_jwk_patch_document + return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) - def patch_entity_datasets( + def patch_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_dataset_patch_document, + json_api_knowledge_recommendation_patch_document, **kwargs ): - """Patch a Dataset (beta) # noqa: E501 + """Patch a Knowledge Recommendation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_datasets(workspace_id, object_id, json_api_dataset_patch_document, async_req=True) + >>> thread = api.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_dataset_patch_document (JsonApiDatasetPatchDocument): + json_api_knowledge_recommendation_patch_document (JsonApiKnowledgeRecommendationPatchDocument): 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] @@ -40957,7 +45501,7 @@ def patch_entity_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -40990,29 +45534,29 @@ def patch_entity_datasets( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_dataset_patch_document'] = \ - json_api_dataset_patch_document - return self.patch_entity_datasets_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_knowledge_recommendation_patch_document'] = \ + json_api_knowledge_recommendation_patch_document + return self.patch_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def patch_entity_export_definitions( + def patch_entity_labels( self, workspace_id, object_id, - json_api_export_definition_patch_document, + json_api_label_patch_document, **kwargs ): - """Patch an Export Definition # noqa: E501 + """Patch a Label (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_export_definitions(workspace_id, object_id, json_api_export_definition_patch_document, async_req=True) + >>> thread = api.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_export_definition_patch_document (JsonApiExportDefinitionPatchDocument): + json_api_label_patch_document (JsonApiLabelPatchDocument): 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] @@ -41049,7 +45593,7 @@ def patch_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiLabelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41082,27 +45626,27 @@ def patch_entity_export_definitions( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_export_definition_patch_document'] = \ - json_api_export_definition_patch_document - return self.patch_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_label_patch_document'] = \ + json_api_label_patch_document + return self.patch_entity_labels_endpoint.call_with_http_info(**kwargs) - def patch_entity_export_templates( + def patch_entity_llm_providers( self, id, - json_api_export_template_patch_document, + json_api_llm_provider_patch_document, **kwargs ): - """Patch Export Template entity # noqa: E501 + """Patch 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.patch_entity_export_templates(id, json_api_export_template_patch_document, async_req=True) + >>> thread = api.patch_entity_llm_providers(id, json_api_llm_provider_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_export_template_patch_document (JsonApiExportTemplatePatchDocument): + json_api_llm_provider_patch_document (JsonApiLlmProviderPatchDocument): 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] @@ -41138,7 +45682,7 @@ def patch_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41169,29 +45713,29 @@ def patch_entity_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_export_template_patch_document'] = \ - json_api_export_template_patch_document - return self.patch_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_llm_provider_patch_document'] = \ + json_api_llm_provider_patch_document + return self.patch_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def patch_entity_facts( + def patch_entity_memory_items( self, workspace_id, object_id, - json_api_fact_patch_document, + json_api_memory_item_patch_document, **kwargs ): - """Patch a Fact (beta) # noqa: E501 + """Patch 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.patch_entity_facts(workspace_id, object_id, json_api_fact_patch_document, async_req=True) + >>> thread = api.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_fact_patch_document (JsonApiFactPatchDocument): + json_api_memory_item_patch_document (JsonApiMemoryItemPatchDocument): 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] @@ -41228,7 +45772,7 @@ def patch_entity_facts( async_req (bool): execute request asynchronously Returns: - JsonApiFactOutDocument + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41261,29 +45805,29 @@ def patch_entity_facts( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_fact_patch_document'] = \ - json_api_fact_patch_document - return self.patch_entity_facts_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_memory_item_patch_document'] = \ + json_api_memory_item_patch_document + return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def patch_entity_filter_contexts( + def patch_entity_metrics( self, workspace_id, object_id, - json_api_filter_context_patch_document, + json_api_metric_patch_document, **kwargs ): - """Patch a Filter Context # noqa: E501 + """Patch 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.patch_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_patch_document, async_req=True) + >>> thread = api.patch_entity_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_filter_context_patch_document (JsonApiFilterContextPatchDocument): + json_api_metric_patch_document (JsonApiMetricPatchDocument): 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] @@ -41320,7 +45864,7 @@ def patch_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiMetricOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41353,33 +45897,30 @@ def patch_entity_filter_contexts( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_filter_context_patch_document'] = \ - json_api_filter_context_patch_document - return self.patch_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_metric_patch_document'] = \ + json_api_metric_patch_document + return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) - def patch_entity_filter_views( + def patch_entity_notification_channels( self, - workspace_id, - object_id, - json_api_filter_view_patch_document, + id, + json_api_notification_channel_patch_document, **kwargs ): - """Patch Filter view # noqa: E501 + """Patch 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.patch_entity_filter_views(workspace_id, object_id, json_api_filter_view_patch_document, async_req=True) + >>> thread = api.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_filter_view_patch_document (JsonApiFilterViewPatchDocument): + id (str): + json_api_notification_channel_patch_document (JsonApiNotificationChannelPatchDocument): 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 @@ -41412,7 +45953,7 @@ def patch_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41441,34 +45982,33 @@ def patch_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 - kwargs['json_api_filter_view_patch_document'] = \ - json_api_filter_view_patch_document - return self.patch_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_notification_channel_patch_document'] = \ + json_api_notification_channel_patch_document + return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def patch_entity_identity_providers( + def patch_entity_org_memory_items( self, id, - json_api_identity_provider_patch_document, + json_api_org_memory_item_patch_document, **kwargs ): - """Patch Identity Provider # noqa: E501 + """Patch an organization Memory Item entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_identity_providers(id, json_api_identity_provider_patch_document, async_req=True) + >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_identity_provider_patch_document (JsonApiIdentityProviderPatchDocument): + json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -41501,7 +46041,7 @@ def patch_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41532,28 +46072,27 @@ def patch_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_identity_provider_patch_document'] = \ - json_api_identity_provider_patch_document - return self.patch_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_org_memory_item_patch_document'] = \ + json_api_org_memory_item_patch_document + return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def patch_entity_jwks( + def patch_entity_organization_settings( self, id, - json_api_jwk_patch_document, + json_api_organization_setting_patch_document, **kwargs ): - """Patch Jwk # noqa: E501 + """Patch Organization Setting entity # noqa: E501 - Patches 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.patch_entity_jwks(id, json_api_jwk_patch_document, async_req=True) + >>> thread = api.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_jwk_patch_document (JsonApiJwkPatchDocument): + json_api_organization_setting_patch_document (JsonApiOrganizationSettingPatchDocument): 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] @@ -41589,7 +46128,7 @@ def patch_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41620,29 +46159,27 @@ def patch_entity_jwks( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_jwk_patch_document'] = \ - json_api_jwk_patch_document - return self.patch_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_organization_setting_patch_document'] = \ + json_api_organization_setting_patch_document + return self.patch_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def patch_entity_knowledge_recommendations( + def patch_entity_organizations( self, - workspace_id, - object_id, - json_api_knowledge_recommendation_patch_document, + id, + json_api_organization_patch_document, **kwargs ): - """Patch a Knowledge Recommendation # noqa: E501 + """Patch Organization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, async_req=True) + >>> thread = api.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_knowledge_recommendation_patch_document (JsonApiKnowledgeRecommendationPatchDocument): + id (str): + json_api_organization_patch_document (JsonApiOrganizationPatchDocument): 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] @@ -41679,7 +46216,7 @@ def patch_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiOrganizationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41708,33 +46245,31 @@ def patch_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_knowledge_recommendation_patch_document'] = \ - json_api_knowledge_recommendation_patch_document - return self.patch_entity_knowledge_recommendations_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_labels( + def patch_entity_parameters( self, workspace_id, object_id, - json_api_label_patch_document, + json_api_parameter_patch_document, **kwargs ): - """Patch a Label (beta) # noqa: E501 + """Patch a Parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_labels(workspace_id, object_id, json_api_label_patch_document, async_req=True) + >>> thread = api.patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_label_patch_document (JsonApiLabelPatchDocument): + json_api_parameter_patch_document (JsonApiParameterPatchDocument): 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] @@ -41771,7 +46306,7 @@ def patch_entity_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutDocument + JsonApiParameterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41804,30 +46339,33 @@ def patch_entity_labels( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_label_patch_document'] = \ - json_api_label_patch_document - return self.patch_entity_labels_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_parameter_patch_document'] = \ + json_api_parameter_patch_document + return self.patch_entity_parameters_endpoint.call_with_http_info(**kwargs) - def patch_entity_llm_providers( + def patch_entity_report_page_layouts( self, - id, - json_api_llm_provider_patch_document, + workspace_id, + object_id, + json_api_report_page_layout_patch_document, **kwargs ): - """Patch LLM Provider entity # noqa: E501 + """Patch a Report Page Layout # 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_llm_providers(id, json_api_llm_provider_patch_document, async_req=True) + >>> thread = api.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_llm_provider_patch_document (JsonApiLlmProviderPatchDocument): + workspace_id (str): + object_id (str): + json_api_report_page_layout_patch_document (JsonApiReportPageLayoutPatchDocument): 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 @@ -41860,7 +46398,7 @@ def patch_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41889,31 +46427,33 @@ def patch_entity_llm_providers( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_llm_provider_patch_document'] = \ - json_api_llm_provider_patch_document - return self.patch_entity_llm_providers_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_report_page_layout_patch_document'] = \ + json_api_report_page_layout_patch_document + return self.patch_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def patch_entity_memory_items( + def patch_entity_report_templates( self, workspace_id, object_id, - json_api_memory_item_patch_document, + json_api_report_template_patch_document, **kwargs ): - """Patch a Memory Item # noqa: E501 + """Patch a Report 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_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, async_req=True) + >>> thread = api.patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_memory_item_patch_document (JsonApiMemoryItemPatchDocument): + json_api_report_template_patch_document (JsonApiReportTemplatePatchDocument): 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] @@ -41950,7 +46490,7 @@ def patch_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -41983,29 +46523,29 @@ def patch_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_memory_item_patch_document'] = \ - json_api_memory_item_patch_document - return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_template_patch_document'] = \ + json_api_report_template_patch_document + return self.patch_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def patch_entity_metrics( + def patch_entity_reports( self, workspace_id, object_id, - json_api_metric_patch_document, + json_api_report_patch_document, **kwargs ): - """Patch a Metric # noqa: E501 + """Patch a Report # 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_metrics(workspace_id, object_id, json_api_metric_patch_document, async_req=True) + >>> thread = api.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_metric_patch_document (JsonApiMetricPatchDocument): + json_api_report_patch_document (JsonApiReportPatchDocument): 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] @@ -42042,7 +46582,7 @@ def patch_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42075,27 +46615,27 @@ def patch_entity_metrics( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_metric_patch_document'] = \ - json_api_metric_patch_document - return self.patch_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_patch_document'] = \ + json_api_report_patch_document + return self.patch_entity_reports_endpoint.call_with_http_info(**kwargs) - def patch_entity_notification_channels( + def patch_entity_themes( self, id, - json_api_notification_channel_patch_document, + json_api_theme_patch_document, **kwargs ): - """Patch Notification Channel entity # noqa: E501 + """Patch Theming # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_notification_channels(id, json_api_notification_channel_patch_document, async_req=True) + >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_notification_channel_patch_document (JsonApiNotificationChannelPatchDocument): + json_api_theme_patch_document (JsonApiThemePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42131,7 +46671,7 @@ def patch_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutDocument + JsonApiThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42162,27 +46702,29 @@ def patch_entity_notification_channels( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_notification_channel_patch_document'] = \ - json_api_notification_channel_patch_document - return self.patch_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_theme_patch_document'] = \ + json_api_theme_patch_document + return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) - def patch_entity_org_memory_items( + def patch_entity_user_data_filters( self, - id, - json_api_org_memory_item_patch_document, + workspace_id, + object_id, + json_api_user_data_filter_patch_document, **kwargs ): - """Patch an organization Memory Item entity # noqa: E501 + """Patch a User Data Filter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) + >>> thread = api.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): + workspace_id (str): + object_id (str): + json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): 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] @@ -42219,7 +46761,7 @@ def patch_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutDocument + JsonApiUserDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42248,32 +46790,36 @@ def patch_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_org_memory_item_patch_document'] = \ - json_api_org_memory_item_patch_document - return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_user_data_filter_patch_document'] = \ + json_api_user_data_filter_patch_document + return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) - def patch_entity_organization_settings( + def patch_entity_user_groups( self, id, - json_api_organization_setting_patch_document, + json_api_user_group_patch_document, **kwargs ): - """Patch Organization Setting entity # noqa: E501 + """Patch UserGroup entity # noqa: E501 + User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_organization_settings(id, json_api_organization_setting_patch_document, async_req=True) + >>> thread = api.patch_entity_user_groups(id, json_api_user_group_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_organization_setting_patch_document (JsonApiOrganizationSettingPatchDocument): + json_api_user_group_patch_document (JsonApiUserGroupPatchDocument): 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 @@ -42306,7 +46852,7 @@ def patch_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutDocument + JsonApiUserGroupOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42337,27 +46883,28 @@ def patch_entity_organization_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_organization_setting_patch_document'] = \ - json_api_organization_setting_patch_document - return self.patch_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_user_group_patch_document'] = \ + json_api_user_group_patch_document + return self.patch_entity_user_groups_endpoint.call_with_http_info(**kwargs) - def patch_entity_organizations( + def patch_entity_users( self, id, - json_api_organization_patch_document, + json_api_user_patch_document, **kwargs ): - """Patch Organization # noqa: E501 + """Patch 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.patch_entity_organizations(id, json_api_organization_patch_document, async_req=True) + >>> thread = api.patch_entity_users(id, json_api_user_patch_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_organization_patch_document (JsonApiOrganizationPatchDocument): + json_api_user_patch_document (JsonApiUserPatchDocument): 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] @@ -42394,7 +46941,7 @@ def patch_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + JsonApiUserOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42425,29 +46972,29 @@ def patch_entity_organizations( 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['json_api_user_patch_document'] = \ + json_api_user_patch_document + return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) - def patch_entity_parameters( + def patch_entity_visualization_objects( self, workspace_id, object_id, - json_api_parameter_patch_document, + json_api_visualization_object_patch_document, **kwargs ): - """Patch a Parameter # noqa: E501 + """Patch a Visualization Object # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_parameters(workspace_id, object_id, json_api_parameter_patch_document, async_req=True) + >>> thread = api.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_parameter_patch_document (JsonApiParameterPatchDocument): + json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42484,7 +47031,7 @@ def patch_entity_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutDocument + JsonApiVisualizationObjectOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42517,27 +47064,29 @@ def patch_entity_parameters( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_parameter_patch_document'] = \ - json_api_parameter_patch_document - return self.patch_entity_parameters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_visualization_object_patch_document'] = \ + json_api_visualization_object_patch_document + return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) - def patch_entity_themes( + def patch_entity_workspace_color_palettes( self, - id, - json_api_theme_patch_document, + workspace_id, + object_id, + json_api_workspace_color_palette_patch_document, **kwargs ): - """Patch Theming # noqa: E501 + """Patch a Workspace Color Palette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_themes(id, json_api_theme_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_theme_patch_document (JsonApiThemePatchDocument): + workspace_id (str): + object_id (str): + json_api_workspace_color_palette_patch_document (JsonApiWorkspaceColorPalettePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -42573,7 +47122,7 @@ def patch_entity_themes( async_req (bool): execute request asynchronously Returns: - JsonApiThemeOutDocument + JsonApiWorkspaceColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42602,31 +47151,33 @@ def patch_entity_themes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_theme_patch_document'] = \ - json_api_theme_patch_document - return self.patch_entity_themes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_color_palette_patch_document'] = \ + json_api_workspace_color_palette_patch_document + return self.patch_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) - def patch_entity_user_data_filters( + def patch_entity_workspace_data_filter_settings( self, workspace_id, object_id, - json_api_user_data_filter_patch_document, + json_api_workspace_data_filter_setting_patch_document, **kwargs ): - """Patch a User Data Filter # noqa: E501 + """Patch 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.patch_entity_user_data_filters(workspace_id, object_id, json_api_user_data_filter_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_user_data_filter_patch_document (JsonApiUserDataFilterPatchDocument): + json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): 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] @@ -42663,7 +47214,7 @@ def patch_entity_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutDocument + JsonApiWorkspaceDataFilterSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42696,28 +47247,29 @@ def patch_entity_user_data_filters( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_user_data_filter_patch_document'] = \ - json_api_user_data_filter_patch_document - return self.patch_entity_user_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ + json_api_workspace_data_filter_setting_patch_document + return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def patch_entity_user_groups( + def patch_entity_workspace_data_filters( self, - id, - json_api_user_group_patch_document, + workspace_id, + object_id, + json_api_workspace_data_filter_patch_document, **kwargs ): - """Patch UserGroup entity # noqa: E501 + """Patch a Workspace Data Filter # noqa: E501 - User Group - creates tree-like structure for categorizing users # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_user_groups(id, json_api_user_group_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_user_group_patch_document (JsonApiUserGroupPatchDocument): + workspace_id (str): + object_id (str): + json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): 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] @@ -42754,7 +47306,7 @@ def patch_entity_user_groups( async_req (bool): execute request asynchronously Returns: - JsonApiUserGroupOutDocument + JsonApiWorkspaceDataFilterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42783,34 +47335,36 @@ def patch_entity_user_groups( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_group_patch_document'] = \ - json_api_user_group_patch_document - return self.patch_entity_user_groups_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_data_filter_patch_document'] = \ + json_api_workspace_data_filter_patch_document + return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def patch_entity_users( + def patch_entity_workspace_export_templates( self, - id, - json_api_user_patch_document, + workspace_id, + object_id, + json_api_workspace_export_template_patch_document, **kwargs ): - """Patch User entity # noqa: E501 + """Patch a Workspace Export Template # 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.patch_entity_users(id, json_api_user_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_user_patch_document (JsonApiUserPatchDocument): + workspace_id (str): + object_id (str): + json_api_workspace_export_template_patch_document (JsonApiWorkspaceExportTemplatePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -42843,7 +47397,7 @@ def patch_entity_users( async_req (bool): execute request asynchronously Returns: - JsonApiUserOutDocument + JsonApiWorkspaceExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42872,35 +47426,36 @@ def patch_entity_users( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_user_patch_document'] = \ - json_api_user_patch_document - return self.patch_entity_users_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_workspace_export_template_patch_document'] = \ + json_api_workspace_export_template_patch_document + return self.patch_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) - def patch_entity_visualization_objects( + def patch_entity_workspace_settings( self, workspace_id, object_id, - json_api_visualization_object_patch_document, + json_api_workspace_setting_patch_document, **kwargs ): - """Patch a Visualization Object # noqa: E501 + """Patch 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.patch_entity_visualization_objects(workspace_id, object_id, json_api_visualization_object_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_visualization_object_patch_document (JsonApiVisualizationObjectPatchDocument): + json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): 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 @@ -42933,7 +47488,7 @@ def patch_entity_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutDocument + JsonApiWorkspaceSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -42966,29 +47521,29 @@ def patch_entity_visualization_objects( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_visualization_object_patch_document'] = \ - json_api_visualization_object_patch_document - return self.patch_entity_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_setting_patch_document'] = \ + json_api_workspace_setting_patch_document + return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspace_color_palettes( + def patch_entity_workspace_themes( self, workspace_id, object_id, - json_api_workspace_color_palette_patch_document, + json_api_workspace_theme_patch_document, **kwargs ): - """Patch a Workspace Color Palette # noqa: E501 + """Patch a Workspace Theme # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_workspace_color_palettes(workspace_id, object_id, json_api_workspace_color_palette_patch_document, async_req=True) + >>> thread = api.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_workspace_color_palette_patch_document (JsonApiWorkspaceColorPalettePatchDocument): + json_api_workspace_theme_patch_document (JsonApiWorkspaceThemePatchDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -43024,7 +47579,7 @@ def patch_entity_workspace_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceColorPaletteOutDocument + JsonApiWorkspaceThemeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43057,29 +47612,28 @@ def patch_entity_workspace_color_palettes( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_workspace_color_palette_patch_document'] = \ - json_api_workspace_color_palette_patch_document - return self.patch_entity_workspace_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_workspace_theme_patch_document'] = \ + json_api_workspace_theme_patch_document + return self.patch_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspace_data_filter_settings( + def patch_entity_workspaces( self, - workspace_id, - object_id, - json_api_workspace_data_filter_setting_patch_document, + id, + json_api_workspace_patch_document, **kwargs ): - """Patch a Settings for Workspace Data Filter # noqa: E501 + """Patch 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.patch_entity_workspace_data_filter_settings(workspace_id, object_id, json_api_workspace_data_filter_setting_patch_document, async_req=True) + >>> thread = api.patch_entity_workspaces(id, json_api_workspace_patch_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_workspace_data_filter_setting_patch_document (JsonApiWorkspaceDataFilterSettingPatchDocument): + id (str): + json_api_workspace_patch_document (JsonApiWorkspacePatchDocument): 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] @@ -43116,7 +47670,7 @@ def patch_entity_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutDocument + JsonApiWorkspaceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -43145,37 +47699,33 @@ def patch_entity_workspace_data_filter_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_setting_patch_document'] = \ - json_api_workspace_data_filter_setting_patch_document - return self.patch_entity_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_workspace_patch_document'] = \ + json_api_workspace_patch_document + return self.patch_entity_workspaces_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspace_data_filters( + def search_entities_aggregated_facts( self, workspace_id, - object_id, - json_api_workspace_data_filter_patch_document, + entity_search_body, **kwargs ): - """Patch a Workspace Data Filter # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_workspace_data_filters(workspace_id, object_id, json_api_workspace_data_filter_patch_document, async_req=True) + >>> thread = api.search_entities_aggregated_facts(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_workspace_data_filter_patch_document (JsonApiWorkspaceDataFilterPatchDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options 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] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -43208,7 +47758,7 @@ def patch_entity_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutDocument + JsonApiAggregatedFactOutList If the method is called asynchronously, returns the request thread. """ @@ -43239,34 +47789,31 @@ def patch_entity_workspace_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_data_filter_patch_document'] = \ - json_api_workspace_data_filter_patch_document - return self.patch_entity_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspace_export_templates( + def search_entities_analytical_dashboards( self, workspace_id, - object_id, - json_api_workspace_export_template_patch_document, + entity_search_body, **kwargs ): - """Patch a Workspace Export Template # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_workspace_export_templates(workspace_id, object_id, json_api_workspace_export_template_patch_document, async_req=True) + >>> thread = api.search_entities_analytical_dashboards(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_workspace_export_template_patch_document (JsonApiWorkspaceExportTemplatePatchDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options 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] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -43299,7 +47846,7 @@ def patch_entity_workspace_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceExportTemplateOutDocument + JsonApiAnalyticalDashboardOutList If the method is called asynchronously, returns the request thread. """ @@ -43330,34 +47877,31 @@ def patch_entity_workspace_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_export_template_patch_document'] = \ - json_api_workspace_export_template_patch_document - return self.patch_entity_workspace_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspace_settings( + def search_entities_attribute_hierarchies( self, workspace_id, - object_id, - json_api_workspace_setting_patch_document, + entity_search_body, **kwargs ): - """Patch a Setting for Workspace # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_workspace_settings(workspace_id, object_id, json_api_workspace_setting_patch_document, async_req=True) + >>> thread = api.search_entities_attribute_hierarchies(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_workspace_setting_patch_document (JsonApiWorkspaceSettingPatchDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options 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] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -43390,7 +47934,7 @@ def patch_entity_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutDocument + JsonApiAttributeHierarchyOutList If the method is called asynchronously, returns the request thread. """ @@ -43421,34 +47965,31 @@ def patch_entity_workspace_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_setting_patch_document'] = \ - json_api_workspace_setting_patch_document - return self.patch_entity_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspace_themes( + def search_entities_attributes( self, workspace_id, - object_id, - json_api_workspace_theme_patch_document, + entity_search_body, **kwargs ): - """Patch a Workspace Theme # noqa: E501 + """The search endpoint (beta) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.patch_entity_workspace_themes(workspace_id, object_id, json_api_workspace_theme_patch_document, async_req=True) + >>> thread = api.search_entities_attributes(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: workspace_id (str): - object_id (str): - json_api_workspace_theme_patch_document (JsonApiWorkspaceThemePatchDocument): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options 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] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -43481,7 +48022,7 @@ def patch_entity_workspace_themes( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceThemeOutDocument + JsonApiAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -43512,34 +48053,31 @@ def patch_entity_workspace_themes( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_workspace_theme_patch_document'] = \ - json_api_workspace_theme_patch_document - return self.patch_entity_workspace_themes_endpoint.call_with_http_info(**kwargs) + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_attributes_endpoint.call_with_http_info(**kwargs) - def patch_entity_workspaces( + def search_entities_automation_results( self, - id, - json_api_workspace_patch_document, + workspace_id, + entity_search_body, **kwargs ): - """Patch Workspace entity # noqa: E501 + """The search endpoint (beta) # 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.patch_entity_workspaces(id, json_api_workspace_patch_document, async_req=True) + >>> thread = api.search_entities_automation_results(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_workspace_patch_document (JsonApiWorkspacePatchDocument): + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options 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] + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -43572,7 +48110,7 @@ def patch_entity_workspaces( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceOutDocument + JsonApiAutomationResultOutList If the method is called asynchronously, returns the request thread. """ @@ -43601,13 +48139,13 @@ def patch_entity_workspaces( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_workspace_patch_document'] = \ - json_api_workspace_patch_document - return self.patch_entity_workspaces_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_automation_results_endpoint.call_with_http_info(**kwargs) - def search_entities_aggregated_facts( + def search_entities_automations( self, workspace_id, entity_search_body, @@ -43618,7 +48156,7 @@ def search_entities_aggregated_facts( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_aggregated_facts(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_automations(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -43660,7 +48198,7 @@ def search_entities_aggregated_facts( async_req (bool): execute request asynchronously Returns: - JsonApiAggregatedFactOutList + JsonApiAutomationOutList If the method is called asynchronously, returns the request thread. """ @@ -43693,9 +48231,9 @@ def search_entities_aggregated_facts( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_aggregated_facts_endpoint.call_with_http_info(**kwargs) + return self.search_entities_automations_endpoint.call_with_http_info(**kwargs) - def search_entities_analytical_dashboards( + def search_entities_computed_attributes( self, workspace_id, entity_search_body, @@ -43706,7 +48244,7 @@ def search_entities_analytical_dashboards( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_analytical_dashboards(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_computed_attributes(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -43748,7 +48286,7 @@ def search_entities_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutList + JsonApiComputedAttributeOutList If the method is called asynchronously, returns the request thread. """ @@ -43781,9 +48319,9 @@ def search_entities_analytical_dashboards( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + return self.search_entities_computed_attributes_endpoint.call_with_http_info(**kwargs) - def search_entities_attribute_hierarchies( + def search_entities_custom_application_settings( self, workspace_id, entity_search_body, @@ -43794,7 +48332,7 @@ def search_entities_attribute_hierarchies( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_attribute_hierarchies(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_custom_application_settings(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -43836,7 +48374,7 @@ def search_entities_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutList + JsonApiCustomApplicationSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -43869,9 +48407,9 @@ def search_entities_attribute_hierarchies( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + return self.search_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def search_entities_attributes( + def search_entities_dashboard_plugins( self, workspace_id, entity_search_body, @@ -43882,7 +48420,7 @@ def search_entities_attributes( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_attributes(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_dashboard_plugins(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -43924,7 +48462,7 @@ def search_entities_attributes( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeOutList + JsonApiDashboardPluginOutList If the method is called asynchronously, returns the request thread. """ @@ -43957,9 +48495,9 @@ def search_entities_attributes( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_attributes_endpoint.call_with_http_info(**kwargs) + return self.search_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def search_entities_automation_results( + def search_entities_datasets( self, workspace_id, entity_search_body, @@ -43970,7 +48508,7 @@ def search_entities_automation_results( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_automation_results(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_datasets(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44012,7 +48550,7 @@ def search_entities_automation_results( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationResultOutList + JsonApiDatasetOutList If the method is called asynchronously, returns the request thread. """ @@ -44045,9 +48583,9 @@ def search_entities_automation_results( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_automation_results_endpoint.call_with_http_info(**kwargs) + return self.search_entities_datasets_endpoint.call_with_http_info(**kwargs) - def search_entities_automations( + def search_entities_export_definitions( self, workspace_id, entity_search_body, @@ -44058,7 +48596,7 @@ def search_entities_automations( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_automations(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_export_definitions(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44100,7 +48638,7 @@ def search_entities_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutList + JsonApiExportDefinitionOutList If the method is called asynchronously, returns the request thread. """ @@ -44133,9 +48671,9 @@ def search_entities_automations( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_automations_endpoint.call_with_http_info(**kwargs) + return self.search_entities_export_definitions_endpoint.call_with_http_info(**kwargs) - def search_entities_custom_application_settings( + def search_entities_facts( self, workspace_id, entity_search_body, @@ -44146,7 +48684,7 @@ def search_entities_custom_application_settings( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_custom_application_settings(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_facts(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44188,7 +48726,7 @@ def search_entities_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutList + JsonApiFactOutList If the method is called asynchronously, returns the request thread. """ @@ -44221,9 +48759,9 @@ def search_entities_custom_application_settings( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_custom_application_settings_endpoint.call_with_http_info(**kwargs) + return self.search_entities_facts_endpoint.call_with_http_info(**kwargs) - def search_entities_dashboard_plugins( + def search_entities_filter_contexts( self, workspace_id, entity_search_body, @@ -44234,7 +48772,7 @@ def search_entities_dashboard_plugins( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_dashboard_plugins(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_filter_contexts(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44276,7 +48814,7 @@ def search_entities_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutList + JsonApiFilterContextOutList If the method is called asynchronously, returns the request thread. """ @@ -44309,9 +48847,9 @@ def search_entities_dashboard_plugins( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + return self.search_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) - def search_entities_datasets( + def search_entities_filter_views( self, workspace_id, entity_search_body, @@ -44322,7 +48860,7 @@ def search_entities_datasets( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_datasets(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_filter_views(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44364,7 +48902,7 @@ def search_entities_datasets( async_req (bool): execute request asynchronously Returns: - JsonApiDatasetOutList + JsonApiFilterViewOutList If the method is called asynchronously, returns the request thread. """ @@ -44397,9 +48935,9 @@ def search_entities_datasets( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_datasets_endpoint.call_with_http_info(**kwargs) + return self.search_entities_filter_views_endpoint.call_with_http_info(**kwargs) - def search_entities_export_definitions( + def search_entities_knowledge_recommendations( self, workspace_id, entity_search_body, @@ -44410,7 +48948,7 @@ def search_entities_export_definitions( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_export_definitions(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44452,7 +48990,7 @@ def search_entities_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutList + JsonApiKnowledgeRecommendationOutList If the method is called asynchronously, returns the request thread. """ @@ -44485,9 +49023,9 @@ def search_entities_export_definitions( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_export_definitions_endpoint.call_with_http_info(**kwargs) + return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def search_entities_facts( + def search_entities_labels( self, workspace_id, entity_search_body, @@ -44498,7 +49036,7 @@ def search_entities_facts( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_facts(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_labels(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44540,7 +49078,7 @@ def search_entities_facts( async_req (bool): execute request asynchronously Returns: - JsonApiFactOutList + JsonApiLabelOutList If the method is called asynchronously, returns the request thread. """ @@ -44573,9 +49111,9 @@ def search_entities_facts( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_facts_endpoint.call_with_http_info(**kwargs) + return self.search_entities_labels_endpoint.call_with_http_info(**kwargs) - def search_entities_filter_contexts( + def search_entities_memory_items( self, workspace_id, entity_search_body, @@ -44586,7 +49124,7 @@ def search_entities_filter_contexts( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_filter_contexts(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44628,7 +49166,7 @@ def search_entities_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutList + JsonApiMemoryItemOutList If the method is called asynchronously, returns the request thread. """ @@ -44661,9 +49199,9 @@ def search_entities_filter_contexts( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_filter_contexts_endpoint.call_with_http_info(**kwargs) + return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) - def search_entities_filter_views( + def search_entities_metrics( self, workspace_id, entity_search_body, @@ -44674,7 +49212,7 @@ def search_entities_filter_views( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_filter_views(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_metrics(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44716,7 +49254,7 @@ def search_entities_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutList + JsonApiMetricOutList If the method is called asynchronously, returns the request thread. """ @@ -44749,9 +49287,9 @@ def search_entities_filter_views( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_filter_views_endpoint.call_with_http_info(**kwargs) + return self.search_entities_metrics_endpoint.call_with_http_info(**kwargs) - def search_entities_knowledge_recommendations( + def search_entities_parameters( self, workspace_id, entity_search_body, @@ -44762,7 +49300,7 @@ def search_entities_knowledge_recommendations( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_parameters(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44804,7 +49342,7 @@ def search_entities_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutList + JsonApiParameterOutList If the method is called asynchronously, returns the request thread. """ @@ -44837,9 +49375,9 @@ def search_entities_knowledge_recommendations( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.search_entities_parameters_endpoint.call_with_http_info(**kwargs) - def search_entities_labels( + def search_entities_user_data_filters( self, workspace_id, entity_search_body, @@ -44850,7 +49388,7 @@ def search_entities_labels( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_labels(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_user_data_filters(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44892,7 +49430,7 @@ def search_entities_labels( async_req (bool): execute request asynchronously Returns: - JsonApiLabelOutList + JsonApiUserDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -44925,9 +49463,9 @@ def search_entities_labels( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_labels_endpoint.call_with_http_info(**kwargs) + return self.search_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) - def search_entities_memory_items( + def search_entities_visualization_objects( self, workspace_id, entity_search_body, @@ -44938,7 +49476,7 @@ def search_entities_memory_items( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_visualization_objects(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -44980,7 +49518,7 @@ def search_entities_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutList + JsonApiVisualizationObjectOutList If the method is called asynchronously, returns the request thread. """ @@ -45013,9 +49551,9 @@ def search_entities_memory_items( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) + return self.search_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) - def search_entities_metrics( + def search_entities_workspace_data_filter_settings( self, workspace_id, entity_search_body, @@ -45026,7 +49564,7 @@ def search_entities_metrics( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_metrics(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -45068,7 +49606,7 @@ def search_entities_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutList + JsonApiWorkspaceDataFilterSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -45101,9 +49639,9 @@ def search_entities_metrics( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_metrics_endpoint.call_with_http_info(**kwargs) + return self.search_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) - def search_entities_parameters( + def search_entities_workspace_data_filters( self, workspace_id, entity_search_body, @@ -45114,7 +49652,7 @@ def search_entities_parameters( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_parameters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_workspace_data_filters(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -45156,7 +49694,7 @@ def search_entities_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutList + JsonApiWorkspaceDataFilterOutList If the method is called asynchronously, returns the request thread. """ @@ -45189,9 +49727,9 @@ def search_entities_parameters( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_parameters_endpoint.call_with_http_info(**kwargs) + return self.search_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) - def search_entities_user_data_filters( + def search_entities_workspace_settings( self, workspace_id, entity_search_body, @@ -45202,7 +49740,7 @@ def search_entities_user_data_filters( This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_user_data_filters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.search_entities_workspace_settings(workspace_id, entity_search_body, async_req=True) >>> result = thread.get() Args: @@ -45244,7 +49782,7 @@ def search_entities_user_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiUserDataFilterOutList + JsonApiWorkspaceSettingOutList If the method is called asynchronously, returns the request thread. """ @@ -45277,29 +49815,26 @@ def search_entities_user_data_filters( workspace_id kwargs['entity_search_body'] = \ entity_search_body - return self.search_entities_user_data_filters_endpoint.call_with_http_info(**kwargs) + return self.search_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) - def search_entities_visualization_objects( + def update_entity( self, - workspace_id, - entity_search_body, + id, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """PUT LLM endpoint entity (Removed) # noqa: E501 + Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_visualization_objects(workspace_id, entity_search_body, async_req=True) + >>> thread = api.update_entity(id, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + id (str): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -45332,7 +49867,7 @@ def search_entities_visualization_objects( async_req (bool): execute request asynchronously Returns: - JsonApiVisualizationObjectOutList + None If the method is called asynchronously, returns the request thread. """ @@ -45361,33 +49896,31 @@ def search_entities_visualization_objects( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_visualization_objects_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + return self.update_entity_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_data_filter_settings( + def update_entity_agents( self, - workspace_id, - entity_search_body, + id, + json_api_agent_in_document, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """Put Agent 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.search_entities_workspace_data_filter_settings(workspace_id, entity_search_body, async_req=True) + >>> thread = api.update_entity_agents(id, json_api_agent_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + id (str): + json_api_agent_in_document (JsonApiAgentInDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 @@ -45420,7 +49953,7 @@ def search_entities_workspace_data_filter_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterSettingOutList + JsonApiAgentOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45449,33 +49982,35 @@ def search_entities_workspace_data_filter_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_workspace_data_filter_settings_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_agent_in_document'] = \ + json_api_agent_in_document + return self.update_entity_agents_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_data_filters( + def update_entity_analytical_dashboards( self, workspace_id, - entity_search_body, + object_id, + json_api_analytical_dashboard_in_document, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """Put Dashboards # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_workspace_data_filters(workspace_id, entity_search_body, async_req=True) + >>> thread = api.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + object_id (str): + json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 @@ -45508,7 +50043,7 @@ def search_entities_workspace_data_filters( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceDataFilterOutList + JsonApiAnalyticalDashboardOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45539,31 +50074,35 @@ def search_entities_workspace_data_filters( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_workspace_data_filters_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + kwargs['json_api_analytical_dashboard_in_document'] = \ + json_api_analytical_dashboard_in_document + return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) - def search_entities_workspace_settings( + def update_entity_attribute_hierarchies( self, workspace_id, - entity_search_body, + object_id, + json_api_attribute_hierarchy_in_document, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """Put an Attribute Hierarchy # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_workspace_settings(workspace_id, entity_search_body, async_req=True) + >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + object_id (str): + json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 @@ -45596,7 +50135,7 @@ def search_entities_workspace_settings( async_req (bool): execute request asynchronously Returns: - JsonApiWorkspaceSettingOutList + JsonApiAttributeHierarchyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45627,28 +50166,35 @@ def search_entities_workspace_settings( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_workspace_settings_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + kwargs['json_api_attribute_hierarchy_in_document'] = \ + json_api_attribute_hierarchy_in_document + return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) - def update_entity( + def update_entity_automations( self, - id, + workspace_id, + object_id, + json_api_automation_in_document, **kwargs ): - """PUT LLM endpoint entity (Removed) # noqa: E501 + """Put an Automation # noqa: E501 - Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity(id, async_req=True) + >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) >>> result = thread.get() Args: - id (str): + workspace_id (str): + object_id (str): + json_api_automation_in_document (JsonApiAutomationInDocument): Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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 @@ -45681,7 +50227,7 @@ def update_entity( async_req (bool): execute request asynchronously Returns: - None + JsonApiAutomationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45710,31 +50256,34 @@ def update_entity( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.update_entity_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_automation_in_document'] = \ + json_api_automation_in_document + return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) - def update_entity_agents( + def update_entity_color_palettes( self, id, - json_api_agent_in_document, + json_api_color_palette_in_document, **kwargs ): - """Put Agent entity # noqa: E501 + """Put Color Pallette # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_agents(id, json_api_agent_in_document, async_req=True) + >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_agent_in_document (JsonApiAgentInDocument): + json_api_color_palette_in_document (JsonApiColorPaletteInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -45767,7 +50316,7 @@ def update_entity_agents( async_req (bool): execute request asynchronously Returns: - JsonApiAgentOutDocument + JsonApiColorPaletteOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45798,29 +50347,29 @@ def update_entity_agents( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_agent_in_document'] = \ - json_api_agent_in_document - return self.update_entity_agents_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_color_palette_in_document'] = \ + json_api_color_palette_in_document + return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) - def update_entity_analytical_dashboards( + def update_entity_computed_attributes( self, workspace_id, object_id, - json_api_analytical_dashboard_in_document, + json_api_computed_attribute_in_document, **kwargs ): - """Put Dashboards # noqa: E501 + """Put 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.update_entity_analytical_dashboards(workspace_id, object_id, json_api_analytical_dashboard_in_document, async_req=True) + >>> thread = api.update_entity_computed_attributes(workspace_id, object_id, json_api_computed_attribute_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_analytical_dashboard_in_document (JsonApiAnalyticalDashboardInDocument): + json_api_computed_attribute_in_document (JsonApiComputedAttributeInDocument): 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] @@ -45857,7 +50406,7 @@ def update_entity_analytical_dashboards( async_req (bool): execute request asynchronously Returns: - JsonApiAnalyticalDashboardOutDocument + JsonApiComputedAttributeOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45890,33 +50439,30 @@ def update_entity_analytical_dashboards( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_analytical_dashboard_in_document'] = \ - json_api_analytical_dashboard_in_document - return self.update_entity_analytical_dashboards_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_computed_attribute_in_document'] = \ + json_api_computed_attribute_in_document + return self.update_entity_computed_attributes_endpoint.call_with_http_info(**kwargs) - def update_entity_attribute_hierarchies( + def update_entity_cookie_security_configurations( self, - workspace_id, - object_id, - json_api_attribute_hierarchy_in_document, + id, + json_api_cookie_security_configuration_in_document, **kwargs ): - """Put an Attribute Hierarchy # noqa: E501 + """Put CookieSecurityConfiguration # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_attribute_hierarchies(workspace_id, object_id, json_api_attribute_hierarchy_in_document, async_req=True) + >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_attribute_hierarchy_in_document (JsonApiAttributeHierarchyInDocument): + id (str): + json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -45949,7 +50495,7 @@ def update_entity_attribute_hierarchies( async_req (bool): execute request asynchronously Returns: - JsonApiAttributeHierarchyOutDocument + JsonApiCookieSecurityConfigurationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -45978,37 +50524,33 @@ def update_entity_attribute_hierarchies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_attribute_hierarchy_in_document'] = \ - json_api_attribute_hierarchy_in_document - return self.update_entity_attribute_hierarchies_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_cookie_security_configuration_in_document'] = \ + json_api_cookie_security_configuration_in_document + return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) - def update_entity_automations( + def update_entity_csp_directives( self, - workspace_id, - object_id, - json_api_automation_in_document, + id, + json_api_csp_directive_in_document, **kwargs ): - """Put an Automation # noqa: E501 + """Put CSP Directives # noqa: E501 + Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_automations(workspace_id, object_id, json_api_automation_in_document, async_req=True) + >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_automation_in_document (JsonApiAutomationInDocument): + id (str): + json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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 @@ -46041,7 +50583,7 @@ def update_entity_automations( async_req (bool): execute request asynchronously Returns: - JsonApiAutomationOutDocument + JsonApiCspDirectiveOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46070,31 +50612,31 @@ def update_entity_automations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_automation_in_document'] = \ - json_api_automation_in_document - return self.update_entity_automations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_csp_directive_in_document'] = \ + json_api_csp_directive_in_document + return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) - def update_entity_color_palettes( + def update_entity_custom_application_settings( self, - id, - json_api_color_palette_in_document, + workspace_id, + object_id, + json_api_custom_application_setting_in_document, **kwargs ): - """Put Color Pallette # noqa: E501 + """Put a Custom Application Setting # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_color_palettes(id, json_api_color_palette_in_document, async_req=True) + >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_color_palette_in_document (JsonApiColorPaletteInDocument): + workspace_id (str): + object_id (str): + json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -46130,7 +50672,7 @@ def update_entity_color_palettes( async_req (bool): execute request asynchronously Returns: - JsonApiColorPaletteOutDocument + JsonApiCustomApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46159,29 +50701,31 @@ def update_entity_color_palettes( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_color_palette_in_document'] = \ - json_api_color_palette_in_document - return self.update_entity_color_palettes_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_custom_application_setting_in_document'] = \ + json_api_custom_application_setting_in_document + return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_cookie_security_configurations( + def update_entity_custom_geo_collections( self, id, - json_api_cookie_security_configuration_in_document, + json_api_custom_geo_collection_in_document, **kwargs ): - """Put CookieSecurityConfiguration # noqa: E501 + """Put Custom Geo Collection # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_cookie_security_configurations(id, json_api_cookie_security_configuration_in_document, async_req=True) + >>> thread = api.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_cookie_security_configuration_in_document (JsonApiCookieSecurityConfigurationInDocument): + json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -46217,7 +50761,7 @@ def update_entity_cookie_security_configurations( async_req (bool): execute request asynchronously Returns: - JsonApiCookieSecurityConfigurationOutDocument + JsonApiCustomGeoCollectionOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46248,28 +50792,29 @@ def update_entity_cookie_security_configurations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_cookie_security_configuration_in_document'] = \ - json_api_cookie_security_configuration_in_document - return self.update_entity_cookie_security_configurations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_custom_geo_collection_in_document'] = \ + json_api_custom_geo_collection_in_document + return self.update_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) - def update_entity_csp_directives( + def update_entity_custom_user_application_settings( self, + user_id, id, - json_api_csp_directive_in_document, + json_api_custom_user_application_setting_in_document, **kwargs ): - """Put CSP Directives # noqa: E501 + """Put a custom application setting for the user # noqa: E501 - Context Security Police Directive # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_csp_directives(id, json_api_csp_directive_in_document, async_req=True) + >>> thread = api.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document, async_req=True) >>> result = thread.get() Args: + user_id (str): id (str): - json_api_csp_directive_in_document (JsonApiCspDirectiveInDocument): + json_api_custom_user_application_setting_in_document (JsonApiCustomUserApplicationSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -46305,7 +50850,7 @@ def update_entity_csp_directives( async_req (bool): execute request asynchronously Returns: - JsonApiCspDirectiveOutDocument + JsonApiCustomUserApplicationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46334,34 +50879,37 @@ def update_entity_csp_directives( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['user_id'] = \ + user_id kwargs['id'] = \ id - kwargs['json_api_csp_directive_in_document'] = \ - json_api_csp_directive_in_document - return self.update_entity_csp_directives_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_custom_user_application_setting_in_document'] = \ + json_api_custom_user_application_setting_in_document + return self.update_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_application_settings( + def update_entity_dashboard_plugins( self, workspace_id, object_id, - json_api_custom_application_setting_in_document, + json_api_dashboard_plugin_in_document, **kwargs ): - """Put a Custom Application Setting # noqa: E501 + """Put a Plugin # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_application_settings(workspace_id, object_id, json_api_custom_application_setting_in_document, async_req=True) + >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_custom_application_setting_in_document (JsonApiCustomApplicationSettingInDocument): + json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -46394,7 +50942,7 @@ def update_entity_custom_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomApplicationSettingOutDocument + JsonApiDashboardPluginOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46427,27 +50975,28 @@ def update_entity_custom_application_settings( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_custom_application_setting_in_document'] = \ - json_api_custom_application_setting_in_document - return self.update_entity_custom_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_dashboard_plugin_in_document'] = \ + json_api_dashboard_plugin_in_document + return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_geo_collections( + def update_entity_data_sources( self, id, - json_api_custom_geo_collection_in_document, + json_api_data_source_in_document, **kwargs ): - """Put Custom Geo Collection # noqa: E501 + """Put Data Source entity # noqa: E501 + Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_geo_collections(id, json_api_custom_geo_collection_in_document, async_req=True) + >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_custom_geo_collection_in_document (JsonApiCustomGeoCollectionInDocument): + json_api_data_source_in_document (JsonApiDataSourceInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -46483,7 +51032,7 @@ def update_entity_custom_geo_collections( async_req (bool): execute request asynchronously Returns: - JsonApiCustomGeoCollectionOutDocument + JsonApiDataSourceOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46514,29 +51063,119 @@ def update_entity_custom_geo_collections( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_custom_geo_collection_in_document'] = \ - json_api_custom_geo_collection_in_document - return self.update_entity_custom_geo_collections_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_data_source_in_document'] = \ + json_api_data_source_in_document + return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) - def update_entity_custom_user_application_settings( + def update_entity_export_definitions( + self, + workspace_id, + object_id, + json_api_export_definition_in_document, + **kwargs + ): + """Put an Export Definition # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiExportDefinitionOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_export_definition_in_document'] = \ + json_api_export_definition_in_document + return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + + def update_entity_export_templates( self, - user_id, id, - json_api_custom_user_application_setting_in_document, + json_api_export_template_in_document, **kwargs ): - """Put a custom application setting for the user # noqa: E501 + """PUT Export Template entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_custom_user_application_settings(user_id, id, json_api_custom_user_application_setting_in_document, async_req=True) + >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) >>> result = thread.get() Args: - user_id (str): id (str): - json_api_custom_user_application_setting_in_document (JsonApiCustomUserApplicationSettingInDocument): + json_api_export_template_in_document (JsonApiExportTemplateInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -46572,7 +51211,7 @@ def update_entity_custom_user_application_settings( async_req (bool): execute request asynchronously Returns: - JsonApiCustomUserApplicationSettingOutDocument + JsonApiExportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46601,33 +51240,31 @@ def update_entity_custom_user_application_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['user_id'] = \ - user_id kwargs['id'] = \ id - kwargs['json_api_custom_user_application_setting_in_document'] = \ - json_api_custom_user_application_setting_in_document - return self.update_entity_custom_user_application_settings_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_export_template_in_document'] = \ + json_api_export_template_in_document + return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) - def update_entity_dashboard_plugins( + def update_entity_filter_contexts( self, workspace_id, object_id, - json_api_dashboard_plugin_in_document, + json_api_filter_context_in_document, **kwargs ): - """Put a Plugin # noqa: E501 + """Put a Filter Context # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_dashboard_plugins(workspace_id, object_id, json_api_dashboard_plugin_in_document, async_req=True) + >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_dashboard_plugin_in_document (JsonApiDashboardPluginInDocument): + json_api_filter_context_in_document (JsonApiFilterContextInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -46664,7 +51301,7 @@ def update_entity_dashboard_plugins( async_req (bool): execute request asynchronously Returns: - JsonApiDashboardPluginOutDocument + JsonApiFilterContextOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46697,31 +51334,33 @@ def update_entity_dashboard_plugins( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_dashboard_plugin_in_document'] = \ - json_api_dashboard_plugin_in_document - return self.update_entity_dashboard_plugins_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_filter_context_in_document'] = \ + json_api_filter_context_in_document + return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) - def update_entity_data_sources( + def update_entity_filter_views( self, - id, - json_api_data_source_in_document, + workspace_id, + object_id, + json_api_filter_view_in_document, **kwargs ): - """Put Data Source entity # noqa: E501 + """Put Filter views # noqa: E501 - Data Source - represents data source for the workspace # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_data_sources(id, json_api_data_source_in_document, async_req=True) + >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_data_source_in_document (JsonApiDataSourceInDocument): + workspace_id (str): + object_id (str): + json_api_filter_view_in_document (JsonApiFilterViewInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -46754,7 +51393,7 @@ def update_entity_data_sources( async_req (bool): execute request asynchronously Returns: - JsonApiDataSourceOutDocument + JsonApiFilterViewOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46783,35 +51422,34 @@ def update_entity_data_sources( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_data_source_in_document'] = \ - json_api_data_source_in_document - return self.update_entity_data_sources_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_filter_view_in_document'] = \ + json_api_filter_view_in_document + return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) - def update_entity_export_definitions( + def update_entity_identity_providers( self, - workspace_id, - object_id, - json_api_export_definition_in_document, + id, + json_api_identity_provider_in_document, **kwargs ): - """Put an Export Definition # noqa: E501 + """Put Identity Provider # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_export_definitions(workspace_id, object_id, json_api_export_definition_in_document, async_req=True) + >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_export_definition_in_document (JsonApiExportDefinitionInDocument): + id (str): + json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -46844,7 +51482,7 @@ def update_entity_export_definitions( async_req (bool): execute request asynchronously Returns: - JsonApiExportDefinitionOutDocument + JsonApiIdentityProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46873,34 +51511,33 @@ def update_entity_export_definitions( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_export_definition_in_document'] = \ - json_api_export_definition_in_document - return self.update_entity_export_definitions_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_identity_provider_in_document'] = \ + json_api_identity_provider_in_document + return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) - def update_entity_export_templates( + def update_entity_ip_allowlist_policies( self, id, - json_api_export_template_in_document, + json_api_ip_allowlist_policy_in_document, **kwargs ): - """PUT Export Template entity # noqa: E501 + """Put IpAllowlistPolicy entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_export_templates(id, json_api_export_template_in_document, async_req=True) + >>> thread = api.update_entity_ip_allowlist_policies(id, json_api_ip_allowlist_policy_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_export_template_in_document (JsonApiExportTemplateInDocument): + json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -46933,7 +51570,7 @@ def update_entity_export_templates( async_req (bool): execute request asynchronously Returns: - JsonApiExportTemplateOutDocument + JsonApiIpAllowlistPolicyOutDocument If the method is called asynchronously, returns the request thread. """ @@ -46964,33 +51601,31 @@ def update_entity_export_templates( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_export_template_in_document'] = \ - json_api_export_template_in_document - return self.update_entity_export_templates_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_ip_allowlist_policy_in_document'] = \ + json_api_ip_allowlist_policy_in_document + return self.update_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) - def update_entity_filter_contexts( + def update_entity_jwks( self, - workspace_id, - object_id, - json_api_filter_context_in_document, + id, + json_api_jwk_in_document, **kwargs ): - """Put a Filter Context # noqa: E501 + """Put Jwk # noqa: E501 + Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_filter_contexts(workspace_id, object_id, json_api_filter_context_in_document, async_req=True) + >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_filter_context_in_document (JsonApiFilterContextInDocument): + id (str): + json_api_jwk_in_document (JsonApiJwkInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -47023,7 +51658,7 @@ def update_entity_filter_contexts( async_req (bool): execute request asynchronously Returns: - JsonApiFilterContextOutDocument + JsonApiJwkOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47052,33 +51687,31 @@ def update_entity_filter_contexts( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_filter_context_in_document'] = \ - json_api_filter_context_in_document - return self.update_entity_filter_contexts_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_jwk_in_document'] = \ + json_api_jwk_in_document + return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) - def update_entity_filter_views( + def update_entity_knowledge_recommendations( self, workspace_id, object_id, - json_api_filter_view_in_document, + json_api_knowledge_recommendation_in_document, **kwargs ): - """Put Filter views # noqa: E501 + """Put a Knowledge Recommendation # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_filter_views(workspace_id, object_id, json_api_filter_view_in_document, async_req=True) + >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_filter_view_in_document (JsonApiFilterViewInDocument): + json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -47115,7 +51748,7 @@ def update_entity_filter_views( async_req (bool): execute request asynchronously Returns: - JsonApiFilterViewOutDocument + JsonApiKnowledgeRecommendationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47148,27 +51781,27 @@ def update_entity_filter_views( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_filter_view_in_document'] = \ - json_api_filter_view_in_document - return self.update_entity_filter_views_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_knowledge_recommendation_in_document'] = \ + json_api_knowledge_recommendation_in_document + return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) - def update_entity_identity_providers( + def update_entity_llm_providers( self, id, - json_api_identity_provider_in_document, + json_api_llm_provider_in_document, **kwargs ): - """Put Identity Provider # noqa: E501 + """PUT LLM Provider entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_identity_providers(id, json_api_identity_provider_in_document, async_req=True) + >>> thread = api.update_entity_llm_providers(id, json_api_llm_provider_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_identity_provider_in_document (JsonApiIdentityProviderInDocument): + json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -47204,7 +51837,7 @@ def update_entity_identity_providers( async_req (bool): execute request asynchronously Returns: - JsonApiIdentityProviderOutDocument + JsonApiLlmProviderOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47235,27 +51868,29 @@ def update_entity_identity_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_identity_provider_in_document'] = \ - json_api_identity_provider_in_document - return self.update_entity_identity_providers_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_llm_provider_in_document'] = \ + json_api_llm_provider_in_document + return self.update_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - def update_entity_ip_allowlist_policies( + def update_entity_memory_items( self, - id, - json_api_ip_allowlist_policy_in_document, + workspace_id, + object_id, + json_api_memory_item_in_document, **kwargs ): - """Put IpAllowlistPolicy entity # noqa: E501 + """Put a Memory Item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_ip_allowlist_policies(id, json_api_ip_allowlist_policy_in_document, async_req=True) + >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_ip_allowlist_policy_in_document (JsonApiIpAllowlistPolicyInDocument): + workspace_id (str): + object_id (str): + json_api_memory_item_in_document (JsonApiMemoryItemInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -47292,7 +51927,7 @@ def update_entity_ip_allowlist_policies( async_req (bool): execute request asynchronously Returns: - JsonApiIpAllowlistPolicyOutDocument + JsonApiMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47321,33 +51956,37 @@ def update_entity_ip_allowlist_policies( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_ip_allowlist_policy_in_document'] = \ - json_api_ip_allowlist_policy_in_document - return self.update_entity_ip_allowlist_policies_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_memory_item_in_document'] = \ + json_api_memory_item_in_document + return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_jwks( + def update_entity_metrics( self, - id, - json_api_jwk_in_document, + workspace_id, + object_id, + json_api_metric_in_document, **kwargs ): - """Put Jwk # noqa: E501 + """Put a Metric # noqa: E501 - Updates JSON web key - used to verify JSON web tokens (Jwts) # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_jwks(id, json_api_jwk_in_document, async_req=True) + >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_jwk_in_document (JsonApiJwkInDocument): + workspace_id (str): + object_id (str): + json_api_metric_in_document (JsonApiMetricInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -47380,7 +52019,7 @@ def update_entity_jwks( async_req (bool): execute request asynchronously Returns: - JsonApiJwkOutDocument + JsonApiMetricOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47409,35 +52048,34 @@ def update_entity_jwks( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_jwk_in_document'] = \ - json_api_jwk_in_document - return self.update_entity_jwks_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_metric_in_document'] = \ + json_api_metric_in_document + return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) - def update_entity_knowledge_recommendations( + def update_entity_notification_channels( self, - workspace_id, - object_id, - json_api_knowledge_recommendation_in_document, + id, + json_api_notification_channel_in_document, **kwargs ): - """Put a Knowledge Recommendation # noqa: E501 + """Put Notification Channel entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) + >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): + id (str): + json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -47470,7 +52108,7 @@ def update_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiNotificationChannelOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47499,34 +52137,33 @@ def update_entity_knowledge_recommendations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_knowledge_recommendation_in_document'] = \ - json_api_knowledge_recommendation_in_document - return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_notification_channel_in_document'] = \ + json_api_notification_channel_in_document + return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) - def update_entity_llm_providers( + def update_entity_org_memory_items( self, id, - json_api_llm_provider_in_document, + json_api_org_memory_item_in_document, **kwargs ): - """PUT LLM Provider entity # noqa: E501 + """Put an organization Memory Item entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_llm_providers(id, json_api_llm_provider_in_document, async_req=True) + >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_llm_provider_in_document (JsonApiLlmProviderInDocument): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -47559,7 +52196,7 @@ def update_entity_llm_providers( async_req (bool): execute request asynchronously Returns: - JsonApiLlmProviderOutDocument + JsonApiOrgMemoryItemOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47590,125 +52227,30 @@ def update_entity_llm_providers( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_llm_provider_in_document'] = \ - json_api_llm_provider_in_document - return self.update_entity_llm_providers_endpoint.call_with_http_info(**kwargs) - - def update_entity_memory_items( - self, - workspace_id, - object_id, - json_api_memory_item_in_document, - **kwargs - ): - """Put a Memory Item # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): - object_id (str): - json_api_memory_item_in_document (JsonApiMemoryItemInDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - 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: - JsonApiMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_memory_item_in_document'] = \ - json_api_memory_item_in_document - return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - def update_entity_metrics( + def update_entity_organization_settings( self, - workspace_id, - object_id, - json_api_metric_in_document, + id, + json_api_organization_setting_in_document, **kwargs ): - """Put a Metric # noqa: E501 + """Put Organization Setting entity # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_metrics(workspace_id, object_id, json_api_metric_in_document, async_req=True) + >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) >>> result = thread.get() Args: - workspace_id (str): - object_id (str): - json_api_metric_in_document (JsonApiMetricInDocument): + id (str): + json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -47741,7 +52283,7 @@ def update_entity_metrics( async_req (bool): execute request asynchronously Returns: - JsonApiMetricOutDocument + JsonApiOrganizationSettingOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47770,34 +52312,33 @@ def update_entity_metrics( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['workspace_id'] = \ - workspace_id - kwargs['object_id'] = \ - object_id - kwargs['json_api_metric_in_document'] = \ - json_api_metric_in_document - return self.update_entity_metrics_endpoint.call_with_http_info(**kwargs) + kwargs['id'] = \ + id + kwargs['json_api_organization_setting_in_document'] = \ + json_api_organization_setting_in_document + return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) - def update_entity_notification_channels( + def update_entity_organizations( self, id, - json_api_notification_channel_in_document, + json_api_organization_in_document, **kwargs ): - """Put Notification Channel entity # noqa: E501 + """Put Organization # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_notification_channels(id, json_api_notification_channel_in_document, async_req=True) + >>> thread = api.update_entity_organizations(id, json_api_organization_in_document, async_req=True) >>> result = thread.get() Args: id (str): - json_api_notification_channel_in_document (JsonApiNotificationChannelInDocument): + json_api_organization_in_document (JsonApiOrganizationInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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 @@ -47830,7 +52371,7 @@ def update_entity_notification_channels( async_req (bool): execute request asynchronously Returns: - JsonApiNotificationChannelOutDocument + JsonApiOrganizationOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47861,27 +52402,29 @@ def update_entity_notification_channels( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['id'] = \ id - kwargs['json_api_notification_channel_in_document'] = \ - json_api_notification_channel_in_document - return self.update_entity_notification_channels_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_organization_in_document'] = \ + json_api_organization_in_document + return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) - def update_entity_org_memory_items( + def update_entity_parameters( self, - id, - json_api_org_memory_item_in_document, + workspace_id, + object_id, + json_api_parameter_in_document, **kwargs ): - """Put an organization Memory Item entity # noqa: E501 + """Put a Parameter # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) + >>> thread = api.update_entity_parameters(workspace_id, object_id, json_api_parameter_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + workspace_id (str): + object_id (str): + json_api_parameter_in_document (JsonApiParameterInDocument): Keyword Args: filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] @@ -47918,7 +52461,7 @@ def update_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutDocument + JsonApiParameterOutDocument If the method is called asynchronously, returns the request thread. """ @@ -47947,32 +52490,37 @@ def update_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_org_memory_item_in_document'] = \ - json_api_org_memory_item_in_document - return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_parameter_in_document'] = \ + json_api_parameter_in_document + return self.update_entity_parameters_endpoint.call_with_http_info(**kwargs) - def update_entity_organization_settings( + def update_entity_report_page_layouts( self, - id, - json_api_organization_setting_in_document, + workspace_id, + object_id, + json_api_report_page_layout_in_document, **kwargs ): - """Put Organization Setting entity # noqa: E501 + """Put a Report Page Layout # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_organization_settings(id, json_api_organization_setting_in_document, async_req=True) + >>> thread = api.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_organization_setting_in_document (JsonApiOrganizationSettingInDocument): + workspace_id (str): + object_id (str): + json_api_report_page_layout_in_document (JsonApiReportPageLayoutInDocument): 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 @@ -48005,7 +52553,7 @@ def update_entity_organization_settings( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationSettingOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -48034,29 +52582,33 @@ def update_entity_organization_settings( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_setting_in_document'] = \ - json_api_organization_setting_in_document - return self.update_entity_organization_settings_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_report_page_layout_in_document'] = \ + json_api_report_page_layout_in_document + return self.update_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def update_entity_organizations( + def update_entity_report_templates( self, - id, - json_api_organization_in_document, + workspace_id, + object_id, + json_api_report_template_in_document, **kwargs ): - """Put Organization # noqa: E501 + """Put a Report 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_organizations(id, json_api_organization_in_document, async_req=True) + >>> thread = api.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_organization_in_document (JsonApiOrganizationInDocument): + workspace_id (str): + object_id (str): + json_api_report_template_in_document (JsonApiReportTemplateInDocument): 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] @@ -48093,7 +52645,7 @@ def update_entity_organizations( async_req (bool): execute request asynchronously Returns: - JsonApiOrganizationOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -48122,31 +52674,33 @@ def update_entity_organizations( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_organization_in_document'] = \ - json_api_organization_in_document - return self.update_entity_organizations_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_report_template_in_document'] = \ + json_api_report_template_in_document + return self.update_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def update_entity_parameters( + def update_entity_reports( self, workspace_id, object_id, - json_api_parameter_in_document, + json_api_report_in_document, **kwargs ): - """Put a Parameter # noqa: E501 + """Put a Report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_parameters(workspace_id, object_id, json_api_parameter_in_document, async_req=True) + >>> thread = api.update_entity_reports(workspace_id, object_id, json_api_report_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_parameter_in_document (JsonApiParameterInDocument): + json_api_report_in_document (JsonApiReportInDocument): 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] @@ -48183,7 +52737,7 @@ def update_entity_parameters( async_req (bool): execute request asynchronously Returns: - JsonApiParameterOutDocument + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -48216,9 +52770,9 @@ def update_entity_parameters( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_parameter_in_document'] = \ - json_api_parameter_in_document - return self.update_entity_parameters_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_in_document'] = \ + json_api_report_in_document + return self.update_entity_reports_endpoint.call_with_http_info(**kwargs) def update_entity_themes( self, diff --git a/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py b/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py index 0e14c5536..757f0e551 100644 --- a/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/fact_controller_api.py @@ -95,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -205,6 +206,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" diff --git a/gooddata-api-client/gooddata_api_client/api/facts_api.py b/gooddata-api-client/gooddata_api_client/api/facts_api.py index 141f41de2..688baa544 100644 --- a/gooddata-api-client/gooddata_api_client/api/facts_api.py +++ b/gooddata-api-client/gooddata_api_client/api/facts_api.py @@ -220,6 +220,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -430,6 +431,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" diff --git a/gooddata-api-client/gooddata_api_client/api/filter_context_api.py b/gooddata-api-client/gooddata_api_client/api/filter_context_api.py index 6f48ffdfa..776db1788 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_context_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_context_api.py @@ -83,6 +83,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -236,6 +239,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -347,6 +353,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -439,6 +448,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, }, @@ -596,6 +608,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, }, diff --git a/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py b/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py index 7802e8df8..d11a5d858 100644 --- a/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/filter_context_controller_api.py @@ -83,6 +83,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -236,6 +239,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -347,6 +353,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, ('meta_include',): { @@ -439,6 +448,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, }, @@ -596,6 +608,9 @@ def __init__(self, api_client=None): "ATTRIBUTES": "attributes", "DATASETS": "datasets", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", + "METRICS": "metrics", + "FACTS": "facts", "ALL": "ALL" }, }, diff --git a/gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py b/gooddata-api-client/gooddata_api_client/api/flow_api.py similarity index 66% rename from gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py rename to gooddata-api-client/gooddata_api_client/api/flow_api.py index 00b745b0f..ed23e2707 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_lake_pipe_tables_api.py +++ b/gooddata-api-client/gooddata_api_client/api/flow_api.py @@ -22,14 +22,15 @@ none_type, validate_and_convert_types ) -from gooddata_api_client.model.analyze_statistics_request import AnalyzeStatisticsRequest -from gooddata_api_client.model.create_pipe_table_request import CreatePipeTableRequest -from gooddata_api_client.model.json_api_document_pipe_table import JsonApiDocumentPipeTable -from gooddata_api_client.model.json_api_list_document_pipe_table_summary import JsonApiListDocumentPipeTableSummary -from gooddata_api_client.model.refresh_partition_request import RefreshPartitionRequest +from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens +from gooddata_api_client.model.flow_execution_response import FlowExecutionResponse +from gooddata_api_client.model.flow_operations import FlowOperations +from gooddata_api_client.model.flow_request import FlowRequest +from gooddata_api_client.model.flow_result_metadata import FlowResultMetadata +from gooddata_api_client.model.flow_table_result import FlowTableResult -class AILakePipeTablesApi(object): +class FlowApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -40,307 +41,323 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client - self.analyze_statistics_endpoint = _Endpoint( + self.cancel_flows_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (AfmCancelTokens,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics', - 'operation_id': 'analyze_statistics', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel', + 'operation_id': 'cancel_flows', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'instance_id', - 'analyze_statistics_request', - 'operation_id', + 'workspace_id', + 'afm_cancel_tokens', ], 'required': [ - 'instance_id', - 'analyze_statistics_request', + 'workspace_id', + 'afm_cancel_tokens', ], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'workspace_id', ] }, root_map={ 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { }, 'openapi_types': { - 'instance_id': - (str,), - 'analyze_statistics_request': - (AnalyzeStatisticsRequest,), - 'operation_id': + 'workspace_id': (str,), + 'afm_cancel_tokens': + (AfmCancelTokens,), }, 'attribute_map': { - 'instance_id': 'instanceId', - 'operation_id': 'operation-id', + 'workspace_id': 'workspaceId', }, 'location_map': { - 'instance_id': 'path', - 'analyze_statistics_request': 'body', - 'operation_id': 'header', + 'workspace_id': 'path', + 'afm_cancel_tokens': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json' + ], 'content_type': [ 'application/json' ] }, api_client=api_client ) - self.create_ai_lake_pipe_table_endpoint = _Endpoint( + self.execute_flow_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (FlowExecutionResponse,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables', - 'operation_id': 'create_ai_lake_pipe_table', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow', + 'operation_id': 'execute_flow', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'instance_id', - 'create_pipe_table_request', - 'operation_id', + 'workspace_id', + 'flow_request', ], 'required': [ - 'instance_id', - 'create_pipe_table_request', + 'workspace_id', + 'flow_request', ], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'workspace_id', ] }, root_map={ 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { }, 'openapi_types': { - 'instance_id': - (str,), - 'create_pipe_table_request': - (CreatePipeTableRequest,), - 'operation_id': + 'workspace_id': (str,), + 'flow_request': + (FlowRequest,), }, 'attribute_map': { - 'instance_id': 'instanceId', - 'operation_id': 'operation-id', + 'workspace_id': 'workspaceId', }, 'location_map': { - 'instance_id': 'path', - 'create_pipe_table_request': 'body', - 'operation_id': 'header', + 'workspace_id': 'path', + 'flow_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json' + ], 'content_type': [ 'application/json' ] }, api_client=api_client ) - self.delete_ai_lake_pipe_table_endpoint = _Endpoint( + self.list_flow_operations_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (FlowOperations,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}', - 'operation_id': 'delete_ai_lake_pipe_table', - 'http_method': 'DELETE', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/operations', + 'operation_id': 'list_flow_operations', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'instance_id', - 'table_name', - 'operation_id', + 'workspace_id', ], 'required': [ - 'instance_id', - 'table_name', + 'workspace_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'workspace_id', ] }, root_map={ 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { }, 'openapi_types': { - 'instance_id': - (str,), - 'table_name': - (str,), - 'operation_id': + 'workspace_id': (str,), }, 'attribute_map': { - 'instance_id': 'instanceId', - 'table_name': 'tableName', - 'operation_id': 'operation-id', + 'workspace_id': 'workspaceId', }, 'location_map': { - 'instance_id': 'path', - 'table_name': 'path', - 'operation_id': 'header', + 'workspace_id': 'path', }, 'collection_format_map': { } }, headers_map={ - 'accept': [], + 'accept': [ + 'application/json' + ], 'content_type': [], }, api_client=api_client ) - self.get_ai_lake_pipe_table_endpoint = _Endpoint( + self.retrieve_flow_result_binary_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiDocumentPipeTable,), + 'response_type': (file_type,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}', - 'operation_id': 'get_ai_lake_pipe_table', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary', + 'operation_id': 'retrieve_flow_result_binary', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'instance_id', - 'table_name', + 'workspace_id', + 'result_id', + 'row_offset', + 'row_limit', + 'column_offset', + 'column_limit', ], 'required': [ - 'instance_id', - 'table_name', + 'workspace_id', + 'result_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'workspace_id', ] }, root_map={ 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { }, 'openapi_types': { - 'instance_id': + 'workspace_id': (str,), - 'table_name': + 'result_id': (str,), + 'row_offset': + (int,), + 'row_limit': + (int,), + 'column_offset': + (int,), + 'column_limit': + (int,), }, 'attribute_map': { - 'instance_id': 'instanceId', - 'table_name': 'tableName', + 'workspace_id': 'workspaceId', + 'result_id': 'resultId', + 'row_offset': 'rowOffset', + 'row_limit': 'rowLimit', + 'column_offset': 'columnOffset', + 'column_limit': 'columnLimit', }, 'location_map': { - 'instance_id': 'path', - 'table_name': 'path', + 'workspace_id': 'path', + 'result_id': 'path', + 'row_offset': 'query', + 'row_limit': 'query', + 'column_offset': 'query', + 'column_limit': 'query', }, 'collection_format_map': { } }, headers_map={ 'accept': [ - 'application/json' + 'application/vnd.apache.arrow.file', + 'application/vnd.apache.arrow.stream' ], 'content_type': [], }, api_client=api_client ) - self.list_ai_lake_pipe_tables_endpoint = _Endpoint( + self.retrieve_flow_result_metadata_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiListDocumentPipeTableSummary,), + 'response_type': (FlowResultMetadata,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables', - 'operation_id': 'list_ai_lake_pipe_tables', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata', + 'operation_id': 'retrieve_flow_result_metadata', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'instance_id', - 'page', - 'size', - 'meta_include', + 'workspace_id', + 'result_id', ], 'required': [ - 'instance_id', + 'workspace_id', + 'result_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ - 'page', - 'size', - 'meta_include', + 'workspace_id', ] }, root_map={ 'validations': { - ('page',): { - - 'inclusive_minimum': 0, - }, - ('size',): { - - 'inclusive_maximum': 500, - 'inclusive_minimum': 1, - }, - ('meta_include',): { + ('workspace_id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, }, }, 'allowed_values': { }, 'openapi_types': { - 'instance_id': + 'workspace_id': + (str,), + 'result_id': (str,), - 'page': - (int,), - 'size': - (int,), - 'meta_include': - ([str],), }, 'attribute_map': { - 'instance_id': 'instanceId', - 'page': 'page', - 'size': 'size', - 'meta_include': 'metaInclude', + 'workspace_id': 'workspaceId', + 'result_id': 'resultId', }, 'location_map': { - 'instance_id': 'path', - 'page': 'query', - 'size': 'query', - 'meta_include': 'query', + 'workspace_id': 'path', + 'result_id': 'path', }, 'collection_format_map': { - 'meta_include': 'multi', } }, headers_map={ @@ -351,93 +368,109 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.refresh_ai_lake_pipe_table_partition_endpoint = _Endpoint( + self.retrieve_flow_result_table_endpoint = _Endpoint( settings={ - 'response_type': None, + 'response_type': (FlowTableResult,), 'auth': [], - 'endpoint_path': '/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh', - 'operation_id': 'refresh_ai_lake_pipe_table_partition', - 'http_method': 'POST', + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table', + 'operation_id': 'retrieve_flow_result_table', + 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'instance_id', - 'table_name', - 'refresh_partition_request', - 'operation_id', + 'workspace_id', + 'result_id', + 'row_offset', + 'row_limit', + 'column_offset', + 'column_limit', ], 'required': [ - 'instance_id', - 'table_name', - 'refresh_partition_request', + 'workspace_id', + 'result_id', ], 'nullable': [ ], 'enum': [ ], 'validation': [ + 'workspace_id', ] }, root_map={ 'validations': { + ('workspace_id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, }, 'allowed_values': { }, 'openapi_types': { - 'instance_id': - (str,), - 'table_name': + 'workspace_id': (str,), - 'refresh_partition_request': - (RefreshPartitionRequest,), - 'operation_id': + 'result_id': (str,), + 'row_offset': + (int,), + 'row_limit': + (int,), + 'column_offset': + (int,), + 'column_limit': + (int,), }, 'attribute_map': { - 'instance_id': 'instanceId', - 'table_name': 'tableName', - 'operation_id': 'operation-id', + 'workspace_id': 'workspaceId', + 'result_id': 'resultId', + 'row_offset': 'rowOffset', + 'row_limit': 'rowLimit', + 'column_offset': 'columnOffset', + 'column_limit': 'columnLimit', }, 'location_map': { - 'instance_id': 'path', - 'table_name': 'path', - 'refresh_partition_request': 'body', - 'operation_id': 'header', + 'workspace_id': 'path', + 'result_id': 'path', + 'row_offset': 'query', + 'row_limit': 'query', + 'column_offset': 'query', + 'column_limit': 'query', }, 'collection_format_map': { } }, headers_map={ - 'accept': [], - 'content_type': [ + 'accept': [ 'application/json' - ] + ], + 'content_type': [], }, api_client=api_client ) - def analyze_statistics( + def cancel_flows( self, - instance_id, - analyze_statistics_request, + workspace_id, + afm_cancel_tokens, **kwargs ): - """(BETA) Run ANALYZE TABLE for tables in a database instance # noqa: E501 + """(EXPERIMENTAL) Apply the given cancel tokens to flows # noqa: E501 - (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result. # 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_statistics(instance_id, analyze_statistics_request, async_req=True) + >>> thread = api.cancel_flows(workspace_id, afm_cancel_tokens, async_req=True) >>> result = thread.get() Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - analyze_statistics_request (AnalyzeStatisticsRequest): + workspace_id (str): Workspace identifier + afm_cancel_tokens (AfmCancelTokens): Keyword Args: - operation_id (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -470,7 +503,7 @@ def analyze_statistics( async_req (bool): execute request asynchronously Returns: - None + AfmCancelTokens If the method is called asynchronously, returns the request thread. """ @@ -499,33 +532,32 @@ def analyze_statistics( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['analyze_statistics_request'] = \ - analyze_statistics_request - return self.analyze_statistics_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['afm_cancel_tokens'] = \ + afm_cancel_tokens + return self.cancel_flows_endpoint.call_with_http_info(**kwargs) - def create_ai_lake_pipe_table( + def execute_flow( self, - instance_id, - create_pipe_table_request, + workspace_id, + flow_request, **kwargs ): - """(BETA) Create a new AI Lake pipe table # noqa: E501 + """(EXPERIMENTAL) Execute a flow # noqa: E501 - (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result. # 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_ai_lake_pipe_table(instance_id, create_pipe_table_request, async_req=True) + >>> thread = api.execute_flow(workspace_id, flow_request, async_req=True) >>> result = thread.get() Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - create_pipe_table_request (CreatePipeTableRequest): + workspace_id (str): Workspace identifier + flow_request (FlowRequest): Keyword Args: - operation_id (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -558,7 +590,7 @@ def create_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - None + FlowExecutionResponse If the method is called asynchronously, returns the request thread. """ @@ -587,33 +619,30 @@ def create_ai_lake_pipe_table( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['create_pipe_table_request'] = \ - create_pipe_table_request - return self.create_ai_lake_pipe_table_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['flow_request'] = \ + flow_request + return self.execute_flow_endpoint.call_with_http_info(**kwargs) - def delete_ai_lake_pipe_table( + def list_flow_operations( self, - instance_id, - table_name, + workspace_id, **kwargs ): - """(BETA) Delete an AI Lake pipe table # noqa: E501 + """(EXPERIMENTAL) List the operations of flows # noqa: E501 - (BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.delete_ai_lake_pipe_table(instance_id, table_name, async_req=True) + >>> thread = api.list_flow_operations(workspace_id, async_req=True) >>> result = thread.get() Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - table_name (str): Pipe table name. + workspace_id (str): Workspace identifier Keyword Args: - operation_id (str): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -646,7 +675,7 @@ def delete_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - None + FlowOperations If the method is called asynchronously, returns the request thread. """ @@ -675,32 +704,34 @@ def delete_ai_lake_pipe_table( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['table_name'] = \ - table_name - return self.delete_ai_lake_pipe_table_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.list_flow_operations_endpoint.call_with_http_info(**kwargs) - def get_ai_lake_pipe_table( + def retrieve_flow_result_binary( self, - instance_id, - table_name, + workspace_id, + result_id, **kwargs ): - """(BETA) Get an AI Lake pipe table # noqa: E501 + """(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format # noqa: E501 - (BETA) Returns full details of the specified pipe table. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream. # 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_ai_lake_pipe_table(instance_id, table_name, async_req=True) + >>> thread = api.retrieve_flow_result_binary(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - table_name (str): Pipe table name. + workspace_id (str): Workspace identifier + result_id (str): Result ID Keyword Args: + row_offset (int): Index of the first row to return. The default is 0.. [optional] + row_limit (int): Maximum number of rows to return. The default is all remaining rows.. [optional] + column_offset (int): Index of the first column to return. The default is 0.. [optional] + column_limit (int): Maximum number of columns to return. The default is all remaining columns.. [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 @@ -733,7 +764,7 @@ def get_ai_lake_pipe_table( async_req (bool): execute request asynchronously Returns: - JsonApiDocumentPipeTable + file_type If the method is called asynchronously, returns the request thread. """ @@ -762,33 +793,32 @@ def get_ai_lake_pipe_table( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['table_name'] = \ - table_name - return self.get_ai_lake_pipe_table_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + return self.retrieve_flow_result_binary_endpoint.call_with_http_info(**kwargs) - def list_ai_lake_pipe_tables( + def retrieve_flow_result_metadata( self, - instance_id, + workspace_id, + result_id, **kwargs ): - """(BETA) List AI Lake pipe tables # noqa: E501 + """(EXPERIMENTAL) Get the metadata of a flow result # noqa: E501 - (BETA) Lists active pipe tables in the given AI Lake database instance. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_ai_lake_pipe_tables(instance_id, async_req=True) + >>> thread = api.retrieve_flow_result_metadata(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. + workspace_id (str): Workspace identifier + result_id (str): Result ID Keyword Args: - page (int): Zero-based page number.. [optional] if omitted the server will use the default value of 0 - size (int): Number of items per page.. [optional] if omitted the server will use the default value of 50 - meta_include ([str]): [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -821,7 +851,7 @@ def list_ai_lake_pipe_tables( async_req (bool): execute request asynchronously Returns: - JsonApiListDocumentPipeTableSummary + FlowResultMetadata If the method is called asynchronously, returns the request thread. """ @@ -850,33 +880,36 @@ def list_ai_lake_pipe_tables( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - return self.list_ai_lake_pipe_tables_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + return self.retrieve_flow_result_metadata_endpoint.call_with_http_info(**kwargs) - def refresh_ai_lake_pipe_table_partition( + def retrieve_flow_result_table( self, - instance_id, - table_name, - refresh_partition_request, + workspace_id, + result_id, **kwargs ): - """(BETA) Refresh a pipe table partition # noqa: E501 + """(EXPERIMENTAL) Get a page of a flow result # noqa: E501 - (BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress. # noqa: E501 + Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.refresh_ai_lake_pipe_table_partition(instance_id, table_name, refresh_partition_request, async_req=True) + >>> thread = api.retrieve_flow_result_table(workspace_id, result_id, async_req=True) >>> result = thread.get() Args: - instance_id (str): Database instance identifier. Accepts the database name (preferred) or UUID. - table_name (str): Pipe table name. - refresh_partition_request (RefreshPartitionRequest): + workspace_id (str): Workspace identifier + result_id (str): Result ID Keyword Args: - operation_id (str): [optional] + row_offset (int): Index of the first row to return. The default is 0.. [optional] + row_limit (int): Maximum number of rows to return. The default is all remaining rows.. [optional] + column_offset (int): Index of the first column to return. The default is 0.. [optional] + column_limit (int): Maximum number of columns to return. The default is all remaining columns.. [optional] _return_http_data_only (bool): response data without head status code and headers. Default is True. _preload_content (bool): if False, the urllib3.HTTPResponse object @@ -909,7 +942,7 @@ def refresh_ai_lake_pipe_table_partition( async_req (bool): execute request asynchronously Returns: - None + FlowTableResult If the method is called asynchronously, returns the request thread. """ @@ -938,11 +971,9 @@ def refresh_ai_lake_pipe_table_partition( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['instance_id'] = \ - instance_id - kwargs['table_name'] = \ - table_name - kwargs['refresh_partition_request'] = \ - refresh_partition_request - return self.refresh_ai_lake_pipe_table_partition_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['result_id'] = \ + result_id + return self.retrieve_flow_result_table_endpoint.call_with_http_info(**kwargs) 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 bf670ba89..7c1d6b021 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 @@ -51,6 +51,7 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'image_export_request', + 'x_gdc_debug', ], 'required': [ 'workspace_id', @@ -73,13 +74,17 @@ def __init__(self, api_client=None): (str,), 'image_export_request': (ImageExportRequest,), + 'x_gdc_debug': + (bool,), }, 'attribute_map': { 'workspace_id': 'workspaceId', + 'x_gdc_debug': 'X-Gdc-Debug', }, 'location_map': { 'workspace_id': 'path', 'image_export_request': 'body', + 'x_gdc_debug': 'header', }, 'collection_format_map': { } @@ -225,6 +230,7 @@ def create_image_export( 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 diff --git a/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py b/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py new file mode 100644 index 000000000..ee3b73cb2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/knowledge_recommendations_api.py @@ -0,0 +1,1274 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList +from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument +from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument + + +class KnowledgeRecommendationsApi(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_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', + 'operation_id': 'create_entity_knowledge_recommendations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_knowledge_recommendation_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_knowledge_recommendation_post_optional_id_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'json_api_knowledge_recommendation_post_optional_id_document': + (JsonApiKnowledgeRecommendationPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_knowledge_recommendation_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_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'delete_entity_knowledge_recommendations', + '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_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', + 'operation_id': 'get_all_entities_knowledge_recommendations', + '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',): { + + "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', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'get_entity_knowledge_recommendations', + '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',): { + + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "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_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'patch_entity_knowledge_recommendations', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_knowledge_recommendation_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_knowledge_recommendation_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_knowledge_recommendation_patch_document': + (JsonApiKnowledgeRecommendationPatchDocument,), + '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_knowledge_recommendation_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search', + 'operation_id': 'search_entities_knowledge_recommendations', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_knowledge_recommendations_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', + 'operation_id': 'update_entity_knowledge_recommendations', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_knowledge_recommendation_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_knowledge_recommendation_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "METRICS": "metrics", + "ANALYTICALDASHBOARDS": "analyticalDashboards", + "METRIC": "metric", + "ANALYTICALDASHBOARD": "analyticalDashboard", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'json_api_knowledge_recommendation_in_document': + (JsonApiKnowledgeRecommendationInDocument,), + '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_knowledge_recommendation_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_knowledge_recommendations( + self, + workspace_id, + json_api_knowledge_recommendation_post_optional_id_document, + **kwargs + ): + """Post Knowledge Recommendations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiKnowledgeRecommendationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ + json_api_knowledge_recommendation_post_optional_id_document + return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def delete_entity_knowledge_recommendations( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Knowledge Recommendation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_knowledge_recommendations(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_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_knowledge_recommendations( + self, + workspace_id, + **kwargs + ): + """Get all Knowledge Recommendations # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_knowledge_recommendations(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: + JsonApiKnowledgeRecommendationOutList + 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_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def get_entity_knowledge_recommendations( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Knowledge Recommendation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_knowledge_recommendations(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: + JsonApiKnowledgeRecommendationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def patch_entity_knowledge_recommendations( + self, + workspace_id, + object_id, + json_api_knowledge_recommendation_patch_document, + **kwargs + ): + """Patch a Knowledge Recommendation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_knowledge_recommendation_patch_document (JsonApiKnowledgeRecommendationPatchDocument): + + 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: + JsonApiKnowledgeRecommendationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_knowledge_recommendation_patch_document'] = \ + json_api_knowledge_recommendation_patch_document + return self.patch_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def search_entities_knowledge_recommendations( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiKnowledgeRecommendationOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + + def update_entity_knowledge_recommendations( + self, + workspace_id, + object_id, + json_api_knowledge_recommendation_in_document, + **kwargs + ): + """Put a Knowledge Recommendation # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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: + JsonApiKnowledgeRecommendationOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_knowledge_recommendation_in_document'] = \ + json_api_knowledge_recommendation_in_document + return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/label_controller_api.py b/gooddata-api-client/gooddata_api_client/api/label_controller_api.py index d17e69a18..392dc2517 100644 --- a/gooddata-api-client/gooddata_api_client/api/label_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/label_controller_api.py @@ -95,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -205,6 +206,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" diff --git a/gooddata-api-client/gooddata_api_client/api/labels_api.py b/gooddata-api-client/gooddata_api_client/api/labels_api.py index 3846e0979..18a8d78ad 100644 --- a/gooddata-api-client/gooddata_api_client/api/labels_api.py +++ b/gooddata-api-client/gooddata_api_client/api/labels_api.py @@ -95,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -205,6 +206,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" diff --git a/gooddata-api-client/gooddata_api_client/api/memory_items_api.py b/gooddata-api-client/gooddata_api_client/api/memory_items_api.py new file mode 100644 index 000000000..4471310bd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/memory_items_api.py @@ -0,0 +1,2241 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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.entity_search_body import EntitySearchBody +from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument +from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument +from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList +from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument +from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument +from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument +from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument +from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList +from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument + + +class MemoryItemsApi(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_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', + 'operation_id': 'create_entity_memory_items', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_memory_item_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_memory_item_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_memory_item_post_optional_id_document': + (JsonApiMemoryItemPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_memory_item_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_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'create_entity_org_memory_items', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'json_api_org_memory_item_in_document', + 'include', + ], + 'required': [ + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'include': + ([str],), + }, + 'attribute_map': { + 'include': 'include', + }, + 'location_map': { + 'json_api_org_memory_item_in_document': 'body', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.delete_entity_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'delete_entity_memory_items', + '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_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'delete_entity_org_memory_items', + 'http_method': 'DELETE', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + }, + 'openapi_types': { + 'id': + (str,), + }, + 'attribute_map': { + 'id': 'id', + }, + 'location_map': { + 'id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + self.get_all_entities_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMemoryItemOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', + 'operation_id': 'get_all_entities_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', + ], + '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_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems', + 'operation_id': 'get_all_entities_org_memory_items', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'filter', + 'include', + 'page', + 'size', + 'sort', + 'meta_include', + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "PAGE": "page", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'filter': + (str,), + 'include': + ([str],), + 'page': + (int,), + 'size': + (int,), + 'sort': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'filter': 'filter', + 'include': 'include', + 'page': 'page', + 'size': 'size', + 'sort': 'sort', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'filter': 'query', + 'include': 'query', + 'page': 'query', + 'size': 'query', + 'sort': 'query', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'sort': 'multi', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'get_entity_memory_items', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'filter', + 'include', + 'x_gdc_validate_relations', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'object_id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + 'meta_include', + ], + 'validation': [ + 'meta_include', + ] + }, + root_map={ + 'validations': { + ('meta_include',): { + + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'object_id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', + 'filter': 'filter', + 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'object_id': 'path', + 'filter': 'query', + 'include': 'query', + 'x_gdc_validate_relations': 'header', + 'meta_include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + 'meta_include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'get_entity_org_memory_items', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'filter', + 'include', + ], + 'required': [ + 'id', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.patch_entity_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'patch_entity_memory_items', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_memory_item_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_memory_item_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_memory_item_patch_document': + (JsonApiMemoryItemPatchDocument,), + '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_memory_item_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.patch_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'patch_entity_org_memory_items', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_patch_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_patch_document': + (JsonApiOrgMemoryItemPatchDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_patch_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.search_entities_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMemoryItemOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/search', + 'operation_id': 'search_entities_memory_items', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'entity_search_body', + 'origin', + 'x_gdc_validate_relations', + ], + 'required': [ + 'workspace_id', + 'entity_search_body', + ], + 'nullable': [ + ], + 'enum': [ + 'origin', + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'entity_search_body': + (EntitySearchBody,), + 'origin': + (str,), + 'x_gdc_validate_relations': + (bool,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'origin': 'origin', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + }, + 'location_map': { + 'workspace_id': 'path', + 'entity_search_body': 'body', + 'origin': 'query', + 'x_gdc_validate_relations': 'header', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_entity_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', + 'operation_id': 'update_entity_memory_items', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_memory_item_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_memory_item_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_memory_item_in_document': + (JsonApiMemoryItemInDocument,), + '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_memory_item_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + self.update_entity_org_memory_items_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', + 'operation_id': 'update_entity_org_memory_items', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'id', + 'json_api_org_memory_item_in_document', + 'filter', + 'include', + ], + 'required': [ + 'id', + 'json_api_org_memory_item_in_document', + ], + 'nullable': [ + ], + 'enum': [ + 'include', + ], + 'validation': [ + 'id', + ] + }, + root_map={ + 'validations': { + ('id',): { + + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + }, + 'allowed_values': { + ('include',): { + + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", + "ALL": "ALL" + }, + }, + 'openapi_types': { + 'id': + (str,), + 'json_api_org_memory_item_in_document': + (JsonApiOrgMemoryItemInDocument,), + 'filter': + (str,), + 'include': + ([str],), + }, + 'attribute_map': { + 'id': 'id', + 'filter': 'filter', + 'include': 'include', + }, + 'location_map': { + 'id': 'path', + 'json_api_org_memory_item_in_document': 'body', + 'filter': 'query', + 'include': 'query', + }, + 'collection_format_map': { + 'include': 'csv', + } + }, + headers_map={ + 'accept': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ], + 'content_type': [ + 'application/json', + 'application/vnd.gooddata.api+json' + ] + }, + api_client=api_client + ) + + def create_entity_memory_items( + self, + workspace_id, + json_api_memory_item_post_optional_id_document, + **kwargs + ): + """Post Memory Items # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_memory_item_post_optional_id_document'] = \ + json_api_memory_item_post_optional_id_document + return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) + + def create_entity_org_memory_items( + self, + json_api_org_memory_item_in_document, + **kwargs + ): + """Post organization Memory Item entities # noqa: E501 + + Organization-scoped AI memory item # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + + Keyword Args: + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def delete_entity_memory_items( + self, + workspace_id, + object_id, + **kwargs + ): + """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_memory_items(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_memory_items_endpoint.call_with_http_info(**kwargs) + + def delete_entity_org_memory_items( + self, + id, + **kwargs + ): + """Delete an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.delete_entity_org_memory_items(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_memory_items( + self, + workspace_id, + **kwargs + ): + """Get all Memory Items # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_memory_items(workspace_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _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: + JsonApiMemoryItemOutList + 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_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_org_memory_items( + self, + **kwargs + ): + """Get all organization Memory Item entities # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_all_entities_org_memory_items(async_req=True) + >>> result = thread.get() + + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + page (int): Zero-based page index (0..N). [optional] if omitted the server will use the default value of 0 + size (int): The size of the page to be returned. [optional] if omitted the server will use the default value of 20 + sort ([str]): Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.. [optional] + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_entity_memory_items( + self, + workspace_id, + object_id, + **kwargs + ): + """Get 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.get_entity_memory_items(workspace_id, object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + meta_include ([str]): Include Meta objects.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) + + def get_entity_org_memory_items( + self, + id, + **kwargs + ): + """Get an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_entity_org_memory_items(id, async_req=True) + >>> result = thread.get() + + Args: + id (str): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def patch_entity_memory_items( + self, + workspace_id, + object_id, + json_api_memory_item_patch_document, + **kwargs + ): + """Patch 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.patch_entity_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_memory_item_patch_document (JsonApiMemoryItemPatchDocument): + + 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: + JsonApiMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_memory_item_patch_document'] = \ + json_api_memory_item_patch_document + return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) + + def patch_entity_org_memory_items( + self, + id, + json_api_org_memory_item_patch_document, + **kwargs + ): + """Patch an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_org_memory_item_patch_document'] = \ + json_api_org_memory_item_patch_document + return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + + def search_entities_memory_items( + self, + workspace_id, + entity_search_body, + **kwargs + ): + """The search endpoint (beta) # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + + Keyword Args: + origin (str): [optional] if omitted the server will use the default value of "ALL" + x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiMemoryItemOutList + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['entity_search_body'] = \ + entity_search_body + return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) + + def update_entity_memory_items( + self, + workspace_id, + object_id, + json_api_memory_item_in_document, + **kwargs + ): + """Put a Memory Item # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_memory_item_in_document (JsonApiMemoryItemInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + 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: + JsonApiMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_memory_item_in_document'] = \ + json_api_memory_item_in_document + return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) + + def update_entity_org_memory_items( + self, + id, + json_api_org_memory_item_in_document, + **kwargs + ): + """Put an organization Memory Item entity # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) + >>> result = thread.get() + + Args: + id (str): + json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + + Keyword Args: + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] + include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + JsonApiOrgMemoryItemOutDocument + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + kwargs['id'] = \ + id + kwargs['json_api_org_memory_item_in_document'] = \ + json_api_org_memory_item_in_document + return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/metadata_synchronization_api.py b/gooddata-api-client/gooddata_api_client/api/metadata_synchronization_api.py new file mode 100644 index 000000000..dc26d5d6f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/metadata_synchronization_api.py @@ -0,0 +1,156 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.api_client import ApiClient, Endpoint as _Endpoint +from gooddata_api_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) + + +class MetadataSynchronizationApi(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.sync_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/organization/syncMetadata', + 'operation_id': 'sync_metadata', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [], + }, + api_client=api_client + ) + + def sync_metadata( + self, + **kwargs + ): + """Trigger metadata synchronization # noqa: E501 + + Enqueues an organization-scoped metadata resync, fanning out the organization's current metadata to GenAI, GW Forge, and Automations. Requires organization MANAGE permission. Requests are deduplicated while a resync session is pending for the organization. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.sync_metadata(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _content_type (str/None): force body content-type. + Default is None and content-type will be predicted by allowed + content-types and body. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + _request_auths (list): set to override the auth_settings for an a single + request; this effectively ignores the authentication + in the spec for a single request. + Default is None + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_spec_property_naming'] = kwargs.get( + '_spec_property_naming', False + ) + kwargs['_content_type'] = kwargs.get( + '_content_type') + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['_request_auths'] = kwargs.get('_request_auths', None) + return self.sync_metadata_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py b/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py index 84bdc2b44..6e63da7b8 100644 --- a/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metric_controller_api.py @@ -84,6 +84,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -94,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -244,6 +246,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -254,6 +257,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -362,6 +366,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -372,6 +377,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -461,6 +467,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -625,6 +632,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", diff --git a/gooddata-api-client/gooddata_api_client/api/metrics_api.py b/gooddata-api-client/gooddata_api_client/api/metrics_api.py index b622cc0be..1ddf6ee02 100644 --- a/gooddata-api-client/gooddata_api_client/api/metrics_api.py +++ b/gooddata-api-client/gooddata_api_client/api/metrics_api.py @@ -84,6 +84,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -94,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -244,6 +246,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -254,6 +257,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -362,6 +366,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -372,6 +377,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -461,6 +467,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -625,6 +632,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", diff --git a/gooddata-api-client/gooddata_api_client/api/ai_observability_api.py b/gooddata-api-client/gooddata_api_client/api/observability_api.py similarity index 99% rename from gooddata-api-client/gooddata_api_client/api/ai_observability_api.py rename to gooddata-api-client/gooddata_api_client/api/observability_api.py index a782b927a..1f54e4e93 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_observability_api.py +++ b/gooddata-api-client/gooddata_api_client/api/observability_api.py @@ -24,7 +24,7 @@ ) -class AIObservabilityApi(object): +class ObservabilityApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech diff --git a/gooddata-api-client/gooddata_api_client/api/permissions_api.py b/gooddata-api-client/gooddata_api_client/api/permissions_api.py index 091d18f4c..b196d6c0e 100644 --- a/gooddata-api-client/gooddata_api_client/api/permissions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/permissions_api.py @@ -24,6 +24,7 @@ ) from gooddata_api_client.model.attribute_permissions import AttributePermissions from gooddata_api_client.model.available_assignees import AvailableAssignees +from gooddata_api_client.model.computed_attribute_permissions import ComputedAttributePermissions from gooddata_api_client.model.dashboard_permissions import DashboardPermissions from gooddata_api_client.model.data_source_permission_assignment import DataSourcePermissionAssignment from gooddata_api_client.model.declarative_organization_permission import DeclarativeOrganizationPermission @@ -33,12 +34,15 @@ from gooddata_api_client.model.fact_permissions import FactPermissions from gooddata_api_client.model.label_permissions import LabelPermissions 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 from gooddata_api_client.model.manage_fact_permissions_request_inner import ManageFactPermissionsRequestInner from gooddata_api_client.model.manage_label_permissions_request_inner import ManageLabelPermissionsRequestInner from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner +from gooddata_api_client.model.manage_visualization_permissions_request_inner import ManageVisualizationPermissionsRequestInner from gooddata_api_client.model.metric_permissions import MetricPermissions from gooddata_api_client.model.organization_permission_assignment import OrganizationPermissionAssignment +from gooddata_api_client.model.visualization_permissions import VisualizationPermissions from gooddata_api_client.model.workspace_permission_assignment import WorkspacePermissionAssignment @@ -163,6 +167,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.computed_attribute_permissions_endpoint = _Endpoint( + settings={ + 'response_type': (ComputedAttributePermissions,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions', + 'operation_id': 'computed_attribute_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'computed_attribute_id', + ], + 'required': [ + 'workspace_id', + 'computed_attribute_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'computed_attribute_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'computed_attribute_id': 'computedAttributeId', + }, + 'location_map': { + 'workspace_id': 'path', + 'computed_attribute_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) self.dashboard_permissions_endpoint = _Endpoint( settings={ 'response_type': (DashboardPermissions,), @@ -577,6 +636,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.manage_computed_attribute_permissions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions', + 'operation_id': 'manage_computed_attribute_permissions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'computed_attribute_id', + 'manage_computed_attribute_permissions_request_inner', + ], + 'required': [ + 'workspace_id', + 'computed_attribute_id', + 'manage_computed_attribute_permissions_request_inner', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'computed_attribute_id': + (str,), + 'manage_computed_attribute_permissions_request_inner': + ([ManageComputedAttributePermissionsRequestInner],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'computed_attribute_id': 'computedAttributeId', + }, + 'location_map': { + 'workspace_id': 'path', + 'computed_attribute_id': 'path', + 'manage_computed_attribute_permissions_request_inner': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.manage_dashboard_permissions_endpoint = _Endpoint( settings={ 'response_type': None, @@ -919,6 +1038,66 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.manage_visualization_permissions_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions', + 'operation_id': 'manage_visualization_permissions', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'visualization_object_id', + 'manage_visualization_permissions_request_inner', + ], + 'required': [ + 'workspace_id', + 'visualization_object_id', + 'manage_visualization_permissions_request_inner', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'visualization_object_id': + (str,), + 'manage_visualization_permissions_request_inner': + ([ManageVisualizationPermissionsRequestInner],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'visualization_object_id': 'visualizationObjectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'visualization_object_id': 'path', + 'manage_visualization_permissions_request_inner': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) self.manage_workspace_permissions_endpoint = _Endpoint( settings={ 'response_type': None, @@ -1238,6 +1417,61 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.visualization_permissions_endpoint = _Endpoint( + settings={ + 'response_type': (VisualizationPermissions,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions', + 'operation_id': 'visualization_permissions', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'visualization_object_id', + ], + 'required': [ + 'workspace_id', + 'visualization_object_id', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'workspace_id': + (str,), + 'visualization_object_id': + (str,), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'visualization_object_id': 'visualizationObjectId', + }, + 'location_map': { + 'workspace_id': 'path', + 'visualization_object_id': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) def attribute_permissions( self, @@ -1411,6 +1645,92 @@ def available_assignees( dashboard_id return self.available_assignees_endpoint.call_with_http_info(**kwargs) + def computed_attribute_permissions( + self, + workspace_id, + computed_attribute_id, + **kwargs + ): + """(BETA) Get Computed Attribute Permissions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.computed_attribute_permissions(workspace_id, computed_attribute_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + computed_attribute_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: + ComputedAttributePermissions + 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['computed_attribute_id'] = \ + computed_attribute_id + return self.computed_attribute_permissions_endpoint.call_with_http_info(**kwargs) + def dashboard_permissions( self, workspace_id, @@ -2086,6 +2406,96 @@ def manage_attribute_permissions( manage_attribute_permissions_request_inner return self.manage_attribute_permissions_endpoint.call_with_http_info(**kwargs) + def manage_computed_attribute_permissions( + self, + workspace_id, + computed_attribute_id, + manage_computed_attribute_permissions_request_inner, + **kwargs + ): + """(BETA) Manage Permissions for a Computed Attribute # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.manage_computed_attribute_permissions(workspace_id, computed_attribute_id, manage_computed_attribute_permissions_request_inner, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + computed_attribute_id (str): + manage_computed_attribute_permissions_request_inner ([ManageComputedAttributePermissionsRequestInner]): + + 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['computed_attribute_id'] = \ + computed_attribute_id + kwargs['manage_computed_attribute_permissions_request_inner'] = \ + manage_computed_attribute_permissions_request_inner + return self.manage_computed_attribute_permissions_endpoint.call_with_http_info(**kwargs) + def manage_dashboard_permissions( self, workspace_id, @@ -2616,6 +3026,96 @@ def manage_organization_permissions( organization_permission_assignment return self.manage_organization_permissions_endpoint.call_with_http_info(**kwargs) + def manage_visualization_permissions( + self, + workspace_id, + visualization_object_id, + manage_visualization_permissions_request_inner, + **kwargs + ): + """(BETA) Manage Permissions for a Visualization # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.manage_visualization_permissions(workspace_id, visualization_object_id, manage_visualization_permissions_request_inner, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + visualization_object_id (str): + manage_visualization_permissions_request_inner ([ManageVisualizationPermissionsRequestInner]): + + 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['visualization_object_id'] = \ + visualization_object_id + kwargs['manage_visualization_permissions_request_inner'] = \ + manage_visualization_permissions_request_inner + return self.manage_visualization_permissions_endpoint.call_with_http_info(**kwargs) + def manage_workspace_permissions( self, workspace_id, @@ -3133,3 +3633,89 @@ def set_workspace_permissions( declarative_workspace_permissions return self.set_workspace_permissions_endpoint.call_with_http_info(**kwargs) + def visualization_permissions( + self, + workspace_id, + visualization_object_id, + **kwargs + ): + """(BETA) Get Visualization Permissions # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.visualization_permissions(workspace_id, visualization_object_id, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + visualization_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: + VisualizationPermissions + 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['visualization_object_id'] = \ + visualization_object_id + return self.visualization_permissions_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/report_controller_api.py b/gooddata-api-client/gooddata_api_client/api/report_controller_api.py new file mode 100644 index 000000000..e58f50c29 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/report_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_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 +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument + + +class ReportControllerApi(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_reports_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports', + 'operation_id': 'create_entity_reports', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_report_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_report_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_post_optional_id_document': + (JsonApiReportPostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_report_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_reports_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'delete_entity_reports', + '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_reports_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportOutList,), + 'auth': [], + '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': [ + '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_reports_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'get_entity_reports', + '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_reports_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'patch_entity_reports', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_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_report_patch_document': + (JsonApiReportPatchDocument,), + '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_report_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_reports_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'update_entity_reports', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_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_report_in_document': + (JsonApiReportInDocument,), + '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_report_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_reports( + self, + workspace_id, + json_api_report_post_optional_id_document, + **kwargs + ): + """Post Report # 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_reports(workspace_id, json_api_report_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_report_post_optional_id_document (JsonApiReportPostOptionalIdDocument): + + 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: + JsonApiReportOutDocument + 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_report_post_optional_id_document'] = \ + json_api_report_post_optional_id_document + return self.create_entity_reports_endpoint.call_with_http_info(**kwargs) + + def delete_entity_reports( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Report # 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_reports(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_reports_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_reports( + self, + workspace_id, + **kwargs + ): + """Get all Reports # 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_reports(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: + JsonApiReportOutList + 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_reports_endpoint.call_with_http_info(**kwargs) + + def get_entity_reports( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Report # 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_reports(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: + JsonApiReportOutDocument + 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_reports_endpoint.call_with_http_info(**kwargs) + + def patch_entity_reports( + self, + workspace_id, + object_id, + json_api_report_patch_document, + **kwargs + ): + """Patch a Report # 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_reports(workspace_id, object_id, json_api_report_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_report_patch_document (JsonApiReportPatchDocument): + + 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: + JsonApiReportOutDocument + 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_report_patch_document'] = \ + json_api_report_patch_document + return self.patch_entity_reports_endpoint.call_with_http_info(**kwargs) + + def update_entity_reports( + self, + workspace_id, + object_id, + json_api_report_in_document, + **kwargs + ): + """Put a Report # 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_reports(workspace_id, object_id, json_api_report_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_report_in_document (JsonApiReportInDocument): + + 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: + JsonApiReportOutDocument + 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_report_in_document'] = \ + json_api_report_in_document + return self.update_entity_reports_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 new file mode 100644 index 000000000..5438f4b44 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/report_export_api.py @@ -0,0 +1,474 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI 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.export_response import ExportResponse +from gooddata_api_client.model.get_image_export202_response_inner import GetImageExport202ResponseInner +from gooddata_api_client.model.report_export_request import ReportExportRequest + + +class ReportExportApi(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_report_export_endpoint = _Endpoint( + settings={ + 'response_type': (ExportResponse,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/report', + 'operation_id': 'create_report_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.get_report_export_endpoint = _Endpoint( + settings={ + 'response_type': (file_type,), + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}', + 'operation_id': 'get_report_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_report_export_metadata_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata', + 'operation_id': 'get_report_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 + ) + + def create_report_export( + self, + workspace_id, + report_export_request, + **kwargs + ): + """(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 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_report_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_report_export_endpoint.call_with_http_info(**kwargs) + + def get_report_export( + self, + workspace_id, + export_id, + **kwargs + ): + """(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 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_report_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_report_export_endpoint.call_with_http_info(**kwargs) + + def get_report_export_metadata( + self, + workspace_id, + export_id, + **kwargs + ): + """(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 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_report_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_report_export_metadata_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/report_page_layout_controller_api.py b/gooddata-api-client/gooddata_api_client/api/report_page_layout_controller_api.py new file mode 100644 index 000000000..2cc0034b9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/report_page_layout_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_report_page_layout_in_document import JsonApiReportPageLayoutInDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument + + +class ReportPageLayoutControllerApi(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_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', + }, + '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_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'delete_entity_report_page_layouts', + '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_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportPageLayoutOutList,), + 'auth': [], + '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': [ + '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_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportPageLayoutOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'get_entity_report_page_layouts', + '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_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportPageLayoutOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'patch_entity_report_page_layouts', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_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_report_page_layout_patch_document': + (JsonApiReportPageLayoutPatchDocument,), + '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_report_page_layout_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_report_page_layouts_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportPageLayoutOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'update_entity_report_page_layouts', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_page_layout_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_report_page_layout_in_document': + (JsonApiReportPageLayoutInDocument,), + '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_report_page_layout_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_report_page_layouts( + self, + workspace_id, + json_api_report_page_layout_post_optional_id_document, + **kwargs + ): + """Post Report Page Layout # 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_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_report_page_layout_post_optional_id_document (JsonApiReportPageLayoutPostOptionalIdDocument): + + 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: + JsonApiReportPageLayoutOutDocument + 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_report_page_layout_post_optional_id_document'] = \ + json_api_report_page_layout_post_optional_id_document + return self.create_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) + + def delete_entity_report_page_layouts( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Report Page Layout # 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_report_page_layouts(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_report_page_layouts_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_report_page_layouts( + self, + workspace_id, + **kwargs + ): + """Get all Report Page Layouts # 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_report_page_layouts(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: + JsonApiReportPageLayoutOutList + 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_report_page_layouts_endpoint.call_with_http_info(**kwargs) + + def get_entity_report_page_layouts( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Report Page Layout # 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_report_page_layouts(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: + JsonApiReportPageLayoutOutDocument + 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_report_page_layouts_endpoint.call_with_http_info(**kwargs) + + def patch_entity_report_page_layouts( + self, + workspace_id, + object_id, + json_api_report_page_layout_patch_document, + **kwargs + ): + """Patch a Report Page Layout # 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_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_report_page_layout_patch_document (JsonApiReportPageLayoutPatchDocument): + + 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: + JsonApiReportPageLayoutOutDocument + 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_report_page_layout_patch_document'] = \ + json_api_report_page_layout_patch_document + return self.patch_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) + + def update_entity_report_page_layouts( + self, + workspace_id, + object_id, + json_api_report_page_layout_in_document, + **kwargs + ): + """Put a Report Page Layout # 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_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_report_page_layout_in_document (JsonApiReportPageLayoutInDocument): + + 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: + JsonApiReportPageLayoutOutDocument + 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_report_page_layout_in_document'] = \ + json_api_report_page_layout_in_document + return self.update_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/report_template_controller_api.py b/gooddata-api-client/gooddata_api_client/api/report_template_controller_api.py new file mode 100644 index 000000000..f6c32621d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/api/report_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_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList +from gooddata_api_client.model.json_api_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument + + +class ReportTemplateControllerApi(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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', + 'operation_id': 'create_entity_report_templates', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'json_api_report_template_post_optional_id_document', + 'include', + 'meta_include', + ], + 'required': [ + 'workspace_id', + 'json_api_report_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_report_template_post_optional_id_document': + (JsonApiReportTemplatePostOptionalIdDocument,), + 'include': + ([str],), + 'meta_include': + ([str],), + }, + 'attribute_map': { + 'workspace_id': 'workspaceId', + 'include': 'include', + 'meta_include': 'metaInclude', + }, + 'location_map': { + 'workspace_id': 'path', + 'json_api_report_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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'delete_entity_report_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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportTemplateOutList,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', + 'operation_id': 'get_all_entities_report_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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'get_entity_report_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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'patch_entity_report_templates', + 'http_method': 'PATCH', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_template_patch_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_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_report_template_patch_document': + (JsonApiReportTemplatePatchDocument,), + '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_report_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_report_templates_endpoint = _Endpoint( + settings={ + 'response_type': (JsonApiReportTemplateOutDocument,), + 'auth': [], + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'update_entity_report_templates', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'workspace_id', + 'object_id', + 'json_api_report_template_in_document', + 'filter', + 'include', + ], + 'required': [ + 'workspace_id', + 'object_id', + 'json_api_report_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_report_template_in_document': + (JsonApiReportTemplateInDocument,), + '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_report_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_report_templates( + self, + workspace_id, + json_api_report_template_post_optional_id_document, + **kwargs + ): + """Post Report 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_report_templates(workspace_id, json_api_report_template_post_optional_id_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + json_api_report_template_post_optional_id_document (JsonApiReportTemplatePostOptionalIdDocument): + + 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: + JsonApiReportTemplateOutDocument + 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_report_template_post_optional_id_document'] = \ + json_api_report_template_post_optional_id_document + return self.create_entity_report_templates_endpoint.call_with_http_info(**kwargs) + + def delete_entity_report_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Delete a Report 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_report_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_report_templates_endpoint.call_with_http_info(**kwargs) + + def get_all_entities_report_templates( + self, + workspace_id, + **kwargs + ): + """Get all Report 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_report_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: + JsonApiReportTemplateOutList + 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_report_templates_endpoint.call_with_http_info(**kwargs) + + def get_entity_report_templates( + self, + workspace_id, + object_id, + **kwargs + ): + """Get a Report 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_report_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: + JsonApiReportTemplateOutDocument + 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_report_templates_endpoint.call_with_http_info(**kwargs) + + def patch_entity_report_templates( + self, + workspace_id, + object_id, + json_api_report_template_patch_document, + **kwargs + ): + """Patch a Report 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_report_templates(workspace_id, object_id, json_api_report_template_patch_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_report_template_patch_document (JsonApiReportTemplatePatchDocument): + + 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: + JsonApiReportTemplateOutDocument + 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_report_template_patch_document'] = \ + json_api_report_template_patch_document + return self.patch_entity_report_templates_endpoint.call_with_http_info(**kwargs) + + def update_entity_report_templates( + self, + workspace_id, + object_id, + json_api_report_template_in_document, + **kwargs + ): + """Put a Report 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_report_templates(workspace_id, object_id, json_api_report_template_in_document, async_req=True) + >>> result = thread.get() + + Args: + workspace_id (str): + object_id (str): + json_api_report_template_in_document (JsonApiReportTemplateInDocument): + + 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: + JsonApiReportTemplateOutDocument + 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_report_template_in_document'] = \ + json_api_report_template_in_document + return self.update_entity_report_templates_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/ai_api.py b/gooddata-api-client/gooddata_api_client/api/reports_api.py similarity index 79% rename from gooddata-api-client/gooddata_api_client/api/ai_api.py rename to gooddata-api-client/gooddata_api_client/api/reports_api.py index e04eb3ccd..2deac5b28 100644 --- a/gooddata-api-client/gooddata_api_client/api/ai_api.py +++ b/gooddata-api-client/gooddata_api_client/api/reports_api.py @@ -22,24 +22,24 @@ none_type, validate_and_convert_types ) -from gooddata_api_client.model.entity_search_body import EntitySearchBody -from gooddata_api_client.model.json_api_knowledge_recommendation_in_document import JsonApiKnowledgeRecommendationInDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_document import JsonApiKnowledgeRecommendationOutDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_out_list import JsonApiKnowledgeRecommendationOutList -from gooddata_api_client.model.json_api_knowledge_recommendation_patch_document import JsonApiKnowledgeRecommendationPatchDocument -from gooddata_api_client.model.json_api_knowledge_recommendation_post_optional_id_document import JsonApiKnowledgeRecommendationPostOptionalIdDocument -from gooddata_api_client.model.json_api_memory_item_in_document import JsonApiMemoryItemInDocument -from gooddata_api_client.model.json_api_memory_item_out_document import JsonApiMemoryItemOutDocument -from gooddata_api_client.model.json_api_memory_item_out_list import JsonApiMemoryItemOutList -from gooddata_api_client.model.json_api_memory_item_patch_document import JsonApiMemoryItemPatchDocument -from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument -from gooddata_api_client.model.json_api_org_memory_item_in_document import JsonApiOrgMemoryItemInDocument -from gooddata_api_client.model.json_api_org_memory_item_out_document import JsonApiOrgMemoryItemOutDocument -from gooddata_api_client.model.json_api_org_memory_item_out_list import JsonApiOrgMemoryItemOutList -from gooddata_api_client.model.json_api_org_memory_item_patch_document import JsonApiOrgMemoryItemPatchDocument - - -class AIApi(object): +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 +from gooddata_api_client.model.json_api_report_page_layout_in_document import JsonApiReportPageLayoutInDocument +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList +from gooddata_api_client.model.json_api_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument + + +class ReportsApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -50,25 +50,25 @@ def __init__(self, api_client=None): if api_client is None: api_client = ApiClient() self.api_client = api_client - self.create_entity_knowledge_recommendations_endpoint = _Endpoint( + self.create_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', - 'operation_id': 'create_entity_knowledge_recommendations', + '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_knowledge_recommendation_post_optional_id_document', + 'json_api_report_page_layout_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_knowledge_recommendation_post_optional_id_document', + 'json_api_report_page_layout_post_optional_id_document', ], 'nullable': [ ], @@ -89,10 +89,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -105,8 +104,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_knowledge_recommendation_post_optional_id_document': - (JsonApiKnowledgeRecommendationPostOptionalIdDocument,), + 'json_api_report_page_layout_post_optional_id_document': + (JsonApiReportPageLayoutPostOptionalIdDocument,), 'include': ([str],), 'meta_include': @@ -119,7 +118,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'workspace_id': 'path', - 'json_api_knowledge_recommendation_post_optional_id_document': 'body', + 'json_api_report_page_layout_post_optional_id_document': 'body', 'include': 'query', 'meta_include': 'query', }, @@ -140,25 +139,25 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_memory_items_endpoint = _Endpoint( + self.create_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', - 'operation_id': 'create_entity_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', + 'operation_id': 'create_entity_report_templates', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ 'workspace_id', - 'json_api_memory_item_post_optional_id_document', + 'json_api_report_template_post_optional_id_document', 'include', 'meta_include', ], 'required': [ 'workspace_id', - 'json_api_memory_item_post_optional_id_document', + 'json_api_report_template_post_optional_id_document', ], 'nullable': [ ], @@ -194,8 +193,8 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'json_api_memory_item_post_optional_id_document': - (JsonApiMemoryItemPostOptionalIdDocument,), + 'json_api_report_template_post_optional_id_document': + (JsonApiReportTemplatePostOptionalIdDocument,), 'include': ([str],), 'meta_include': @@ -208,7 +207,7 @@ def __init__(self, api_client=None): }, 'location_map': { 'workspace_id': 'path', - 'json_api_memory_item_post_optional_id_document': 'body', + 'json_api_report_template_post_optional_id_document': 'body', 'include': 'query', 'meta_include': 'query', }, @@ -229,33 +228,41 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_entity_org_memory_items_endpoint = _Endpoint( + self.create_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems', - 'operation_id': 'create_entity_org_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports', + 'operation_id': 'create_entity_reports', 'http_method': 'POST', 'servers': None, }, params_map={ 'all': [ - 'json_api_org_memory_item_in_document', + 'workspace_id', + 'json_api_report_post_optional_id_document', 'include', + 'meta_include', ], 'required': [ - 'json_api_org_memory_item_in_document', + 'workspace_id', + 'json_api_report_post_optional_id_document', ], 'nullable': [ ], 'enum': [ 'include', + 'meta_include', ], 'validation': [ + 'meta_include', ] }, root_map={ 'validations': { + ('meta_include',): { + + }, }, 'allowed_values': { ('include',): { @@ -265,22 +272,37 @@ def __init__(self, api_client=None): "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'json_api_org_memory_item_in_document': - (JsonApiOrgMemoryItemInDocument,), + 'workspace_id': + (str,), + 'json_api_report_post_optional_id_document': + (JsonApiReportPostOptionalIdDocument,), 'include': ([str],), + 'meta_include': + ([str],), }, 'attribute_map': { + 'workspace_id': 'workspaceId', 'include': 'include', + 'meta_include': 'metaInclude', }, 'location_map': { - 'json_api_org_memory_item_in_document': 'body', + 'workspace_id': 'path', + 'json_api_report_post_optional_id_document': 'body', 'include': 'query', + 'meta_include': 'query', }, 'collection_format_map': { 'include': 'csv', + 'meta_include': 'csv', } }, headers_map={ @@ -295,12 +317,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_knowledge_recommendations_endpoint = _Endpoint( + self.delete_entity_report_page_layouts_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'delete_entity_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'delete_entity_report_page_layouts', 'http_method': 'DELETE', 'servers': None, }, @@ -348,12 +370,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_memory_items_endpoint = _Endpoint( + self.delete_entity_report_templates_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'delete_entity_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'delete_entity_report_templates', 'http_method': 'DELETE', 'servers': None, }, @@ -401,50 +423,49 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.delete_entity_org_memory_items_endpoint = _Endpoint( + self.delete_entity_reports_endpoint = _Endpoint( settings={ 'response_type': None, 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', - 'operation_id': 'delete_entity_org_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'delete_entity_reports', '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': { } @@ -455,12 +476,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_knowledge_recommendations_endpoint = _Endpoint( + self.get_all_entities_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutList,), + 'response_type': (JsonApiReportPageLayoutOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations', - 'operation_id': 'get_all_entities_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts', + 'operation_id': 'get_all_entities_report_page_layouts', 'http_method': 'GET', 'servers': None, }, @@ -505,10 +526,9 @@ def __init__(self, api_client=None): }, ('include',): { - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -576,12 +596,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_memory_items_endpoint = _Endpoint( + self.get_all_entities_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutList,), + 'response_type': (JsonApiReportTemplateOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems', - 'operation_id': 'get_all_entities_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates', + 'operation_id': 'get_all_entities_report_templates', 'http_method': 'GET', 'servers': None, }, @@ -696,28 +716,34 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_all_entities_org_memory_items_endpoint = _Endpoint( + self.get_all_entities_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrgMemoryItemOutList,), + 'response_type': (JsonApiReportOutList,), 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems', - 'operation_id': 'get_all_entities_org_memory_items', + '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', ], @@ -732,6 +758,12 @@ def __init__(self, api_client=None): }, }, 'allowed_values': { + ('origin',): { + + "ALL": "ALL", + "PARENTS": "PARENTS", + "NATIVE": "NATIVE" + }, ('include',): { "USERIDENTIFIERS": "userIdentifiers", @@ -741,12 +773,17 @@ 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': @@ -757,23 +794,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': { @@ -791,12 +836,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_knowledge_recommendations_endpoint = _Endpoint( + self.get_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'get_entity_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'get_entity_report_page_layouts', 'http_method': 'GET', 'servers': None, }, @@ -832,10 +877,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, ('meta_include',): { @@ -889,12 +933,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_memory_items_endpoint = _Endpoint( + self.get_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'get_entity_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'get_entity_report_templates', 'http_method': 'GET', 'servers': None, }, @@ -986,40 +1030,42 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_entity_org_memory_items_endpoint = _Endpoint( + self.get_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', - 'operation_id': 'get_entity_org_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'get_entity_reports', 'http_method': 'GET', 'servers': None, }, params_map={ 'all': [ - 'id', + 'workspace_id', + 'object_id', 'filter', 'include', + 'x_gdc_validate_relations', + 'meta_include', ], 'required': [ - 'id', + 'workspace_id', + 'object_id', ], 'nullable': [ ], 'enum': [ 'include', + 'meta_include', ], 'validation': [ - 'id', + 'meta_include', ] }, root_map={ 'validations': { - ('id',): { + ('meta_include',): { - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, }, }, 'allowed_values': { @@ -1030,27 +1076,46 @@ def __init__(self, api_client=None): "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, + ('meta_include',): { + + "ORIGIN": "origin", + "ALL": "all", + "ALL": "ALL" + }, }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'object_id': (str,), 'filter': (str,), 'include': ([str],), + 'x_gdc_validate_relations': + (bool,), + 'meta_include': + ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', 'include': 'include', + 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', + 'meta_include': 'metaInclude', }, 'location_map': { - 'id': 'path', + '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={ @@ -1062,12 +1127,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_knowledge_recommendations_endpoint = _Endpoint( + self.patch_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'patch_entity_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'patch_entity_report_page_layouts', 'http_method': 'PATCH', 'servers': None, }, @@ -1075,14 +1140,14 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_knowledge_recommendation_patch_document', + 'json_api_report_page_layout_patch_document', 'filter', 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_knowledge_recommendation_patch_document', + 'json_api_report_page_layout_patch_document', ], 'nullable': [ ], @@ -1098,10 +1163,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, }, @@ -1110,8 +1174,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_knowledge_recommendation_patch_document': - (JsonApiKnowledgeRecommendationPatchDocument,), + 'json_api_report_page_layout_patch_document': + (JsonApiReportPageLayoutPatchDocument,), 'filter': (str,), 'include': @@ -1126,7 +1190,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_knowledge_recommendation_patch_document': 'body', + 'json_api_report_page_layout_patch_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -1146,12 +1210,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_memory_items_endpoint = _Endpoint( + self.patch_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'patch_entity_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'patch_entity_report_templates', 'http_method': 'PATCH', 'servers': None, }, @@ -1159,14 +1223,14 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_memory_item_patch_document', + 'json_api_report_template_patch_document', 'filter', 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_memory_item_patch_document', + 'json_api_report_template_patch_document', ], 'nullable': [ ], @@ -1193,8 +1257,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_memory_item_patch_document': - (JsonApiMemoryItemPatchDocument,), + 'json_api_report_template_patch_document': + (JsonApiReportTemplatePatchDocument,), 'filter': (str,), 'include': @@ -1209,7 +1273,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_memory_item_patch_document': 'body', + 'json_api_report_template_patch_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -1229,25 +1293,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.patch_entity_org_memory_items_endpoint = _Endpoint( + self.patch_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', - 'operation_id': 'patch_entity_org_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'patch_entity_reports', 'http_method': 'PATCH', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_org_memory_item_patch_document', + 'workspace_id', + 'object_id', + 'json_api_report_patch_document', 'filter', 'include', ], 'required': [ - 'id', - 'json_api_org_memory_item_patch_document', + 'workspace_id', + 'object_id', + 'json_api_report_patch_document', ], 'nullable': [ ], @@ -1255,17 +1321,10 @@ def __init__(self, api_client=None): 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { ('include',): { @@ -1277,23 +1336,27 @@ def __init__(self, api_client=None): }, }, 'openapi_types': { - 'id': + 'workspace_id': (str,), - 'json_api_org_memory_item_patch_document': - (JsonApiOrgMemoryItemPatchDocument,), + 'object_id': + (str,), + 'json_api_report_patch_document': + (JsonApiReportPatchDocument,), 'filter': (str,), 'include': ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', 'include': 'include', }, 'location_map': { - 'id': 'path', - 'json_api_org_memory_item_patch_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_report_patch_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -1313,160 +1376,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.search_entities_knowledge_recommendations_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search', - 'operation_id': 'search_entities_knowledge_recommendations', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.search_entities_memory_items_endpoint = _Endpoint( - settings={ - 'response_type': (JsonApiMemoryItemOutList,), - 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/search', - 'operation_id': 'search_entities_memory_items', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'entity_search_body', - 'origin', - 'x_gdc_validate_relations', - ], - 'required': [ - 'workspace_id', - 'entity_search_body', - ], - 'nullable': [ - ], - 'enum': [ - 'origin', - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - ('origin',): { - - "ALL": "ALL", - "PARENTS": "PARENTS", - "NATIVE": "NATIVE" - }, - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'entity_search_body': - (EntitySearchBody,), - 'origin': - (str,), - 'x_gdc_validate_relations': - (bool,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - 'origin': 'origin', - 'x_gdc_validate_relations': 'X-GDC-VALIDATE-RELATIONS', - }, - 'location_map': { - 'workspace_id': 'path', - 'entity_search_body': 'body', - 'origin': 'query', - 'x_gdc_validate_relations': 'header', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json', - 'application/vnd.gooddata.api+json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.update_entity_knowledge_recommendations_endpoint = _Endpoint( + self.update_entity_report_page_layouts_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiKnowledgeRecommendationOutDocument,), + 'response_type': (JsonApiReportPageLayoutOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}', - 'operation_id': 'update_entity_knowledge_recommendations', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}', + 'operation_id': 'update_entity_report_page_layouts', 'http_method': 'PUT', 'servers': None, }, @@ -1474,14 +1389,14 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_knowledge_recommendation_in_document', + 'json_api_report_page_layout_in_document', 'filter', 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_knowledge_recommendation_in_document', + 'json_api_report_page_layout_in_document', ], 'nullable': [ ], @@ -1497,10 +1412,9 @@ def __init__(self, api_client=None): 'allowed_values': { ('include',): { - "METRICS": "metrics", - "ANALYTICALDASHBOARDS": "analyticalDashboards", - "METRIC": "metric", - "ANALYTICALDASHBOARD": "analyticalDashboard", + "USERIDENTIFIERS": "userIdentifiers", + "CREATEDBY": "createdBy", + "MODIFIEDBY": "modifiedBy", "ALL": "ALL" }, }, @@ -1509,8 +1423,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_knowledge_recommendation_in_document': - (JsonApiKnowledgeRecommendationInDocument,), + 'json_api_report_page_layout_in_document': + (JsonApiReportPageLayoutInDocument,), 'filter': (str,), 'include': @@ -1525,7 +1439,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_knowledge_recommendation_in_document': 'body', + 'json_api_report_page_layout_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -1545,12 +1459,12 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_memory_items_endpoint = _Endpoint( + self.update_entity_report_templates_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiMemoryItemOutDocument,), + 'response_type': (JsonApiReportTemplateOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}', - 'operation_id': 'update_entity_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reportTemplates/{objectId}', + 'operation_id': 'update_entity_report_templates', 'http_method': 'PUT', 'servers': None, }, @@ -1558,14 +1472,14 @@ def __init__(self, api_client=None): 'all': [ 'workspace_id', 'object_id', - 'json_api_memory_item_in_document', + 'json_api_report_template_in_document', 'filter', 'include', ], 'required': [ 'workspace_id', 'object_id', - 'json_api_memory_item_in_document', + 'json_api_report_template_in_document', ], 'nullable': [ ], @@ -1592,8 +1506,8 @@ def __init__(self, api_client=None): (str,), 'object_id': (str,), - 'json_api_memory_item_in_document': - (JsonApiMemoryItemInDocument,), + 'json_api_report_template_in_document': + (JsonApiReportTemplateInDocument,), 'filter': (str,), 'include': @@ -1608,7 +1522,7 @@ def __init__(self, api_client=None): 'location_map': { 'workspace_id': 'path', 'object_id': 'path', - 'json_api_memory_item_in_document': 'body', + 'json_api_report_template_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -1628,25 +1542,27 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_entity_org_memory_items_endpoint = _Endpoint( + self.update_entity_reports_endpoint = _Endpoint( settings={ - 'response_type': (JsonApiOrgMemoryItemOutDocument,), + 'response_type': (JsonApiReportOutDocument,), 'auth': [], - 'endpoint_path': '/api/v1/entities/orgMemoryItems/{id}', - 'operation_id': 'update_entity_org_memory_items', + 'endpoint_path': '/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}', + 'operation_id': 'update_entity_reports', 'http_method': 'PUT', 'servers': None, }, params_map={ 'all': [ - 'id', - 'json_api_org_memory_item_in_document', + 'workspace_id', + 'object_id', + 'json_api_report_in_document', 'filter', 'include', ], 'required': [ - 'id', - 'json_api_org_memory_item_in_document', + 'workspace_id', + 'object_id', + 'json_api_report_in_document', ], 'nullable': [ ], @@ -1654,17 +1570,10 @@ def __init__(self, api_client=None): 'include', ], 'validation': [ - 'id', ] }, root_map={ 'validations': { - ('id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, }, 'allowed_values': { ('include',): { @@ -1676,23 +1585,27 @@ def __init__(self, api_client=None): }, }, 'openapi_types': { - 'id': + 'workspace_id': + (str,), + 'object_id': (str,), - 'json_api_org_memory_item_in_document': - (JsonApiOrgMemoryItemInDocument,), + 'json_api_report_in_document': + (JsonApiReportInDocument,), 'filter': (str,), 'include': ([str],), }, 'attribute_map': { - 'id': 'id', + 'workspace_id': 'workspaceId', + 'object_id': 'objectId', 'filter': 'filter', 'include': 'include', }, 'location_map': { - 'id': 'path', - 'json_api_org_memory_item_in_document': 'body', + 'workspace_id': 'path', + 'object_id': 'path', + 'json_api_report_in_document': 'body', 'filter': 'query', 'include': 'query', }, @@ -1713,23 +1626,23 @@ def __init__(self, api_client=None): api_client=api_client ) - def create_entity_knowledge_recommendations( + def create_entity_report_page_layouts( self, workspace_id, - json_api_knowledge_recommendation_post_optional_id_document, + json_api_report_page_layout_post_optional_id_document, **kwargs ): - """Post Knowledge Recommendations # noqa: E501 + """Post Report Page Layout # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_knowledge_recommendations(workspace_id, json_api_knowledge_recommendation_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_report_page_layouts(workspace_id, json_api_report_page_layout_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_knowledge_recommendation_post_optional_id_document (JsonApiKnowledgeRecommendationPostOptionalIdDocument): + json_api_report_page_layout_post_optional_id_document (JsonApiReportPageLayoutPostOptionalIdDocument): 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] @@ -1766,7 +1679,7 @@ def create_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1797,27 +1710,27 @@ def create_entity_knowledge_recommendations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_knowledge_recommendation_post_optional_id_document'] = \ - json_api_knowledge_recommendation_post_optional_id_document - return self.create_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_page_layout_post_optional_id_document'] = \ + json_api_report_page_layout_post_optional_id_document + return self.create_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def create_entity_memory_items( + def create_entity_report_templates( self, workspace_id, - json_api_memory_item_post_optional_id_document, + json_api_report_template_post_optional_id_document, **kwargs ): - """Post Memory Items # noqa: E501 + """Post Report 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_memory_items(workspace_id, json_api_memory_item_post_optional_id_document, async_req=True) + >>> thread = api.create_entity_report_templates(workspace_id, json_api_report_template_post_optional_id_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - json_api_memory_item_post_optional_id_document (JsonApiMemoryItemPostOptionalIdDocument): + json_api_report_template_post_optional_id_document (JsonApiReportTemplatePostOptionalIdDocument): 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] @@ -1854,7 +1767,7 @@ def create_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1885,29 +1798,31 @@ def create_entity_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['json_api_memory_item_post_optional_id_document'] = \ - json_api_memory_item_post_optional_id_document - return self.create_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_template_post_optional_id_document'] = \ + json_api_report_template_post_optional_id_document + return self.create_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def create_entity_org_memory_items( + def create_entity_reports( self, - json_api_org_memory_item_in_document, + workspace_id, + json_api_report_post_optional_id_document, **kwargs ): - """Post organization Memory Item entities # noqa: E501 + """Post Report # noqa: E501 - Organization-scoped AI memory item # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.create_entity_org_memory_items(json_api_org_memory_item_in_document, async_req=True) + >>> thread = api.create_entity_reports(workspace_id, json_api_report_post_optional_id_document, async_req=True) >>> result = thread.get() Args: - json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + workspace_id (str): + json_api_report_post_optional_id_document (JsonApiReportPostOptionalIdDocument): 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 @@ -1940,7 +1855,7 @@ def create_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutDocument + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -1969,22 +1884,24 @@ def create_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['json_api_org_memory_item_in_document'] = \ - json_api_org_memory_item_in_document - return self.create_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['json_api_report_post_optional_id_document'] = \ + json_api_report_post_optional_id_document + return self.create_entity_reports_endpoint.call_with_http_info(**kwargs) - def delete_entity_knowledge_recommendations( + def delete_entity_report_page_layouts( self, workspace_id, object_id, **kwargs ): - """Delete a Knowledge Recommendation # noqa: E501 + """Delete a Report Page Layout # 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_report_page_layouts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -2057,20 +1974,20 @@ def delete_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - return self.delete_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.delete_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def delete_entity_memory_items( + def delete_entity_report_templates( self, workspace_id, object_id, **kwargs ): - """Delete a Memory Item # noqa: E501 + """Delete a Report 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_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.delete_entity_report_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -2143,23 +2060,25 @@ 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_report_templates_endpoint.call_with_http_info(**kwargs) - def delete_entity_org_memory_items( + def delete_entity_reports( self, - id, + workspace_id, + object_id, **kwargs ): - """Delete an organization Memory Item entity # noqa: E501 + """Delete a Report # 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_reports(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 @@ -2223,21 +2142,23 @@ def delete_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.delete_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + return self.delete_entity_reports_endpoint.call_with_http_info(**kwargs) - def get_all_entities_knowledge_recommendations( + def get_all_entities_report_page_layouts( self, workspace_id, **kwargs ): - """Get all Knowledge Recommendations # noqa: E501 + """Get all Report Page Layouts # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_knowledge_recommendations(workspace_id, async_req=True) + >>> thread = api.get_all_entities_report_page_layouts(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -2284,7 +2205,7 @@ def get_all_entities_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutList + JsonApiReportPageLayoutOutList If the method is called asynchronously, returns the request thread. """ @@ -2315,19 +2236,19 @@ def get_all_entities_knowledge_recommendations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def get_all_entities_memory_items( + def get_all_entities_report_templates( self, workspace_id, **kwargs ): - """Get all Memory Items # noqa: E501 + """Get all Report 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_memory_items(workspace_id, async_req=True) + >>> thread = api.get_all_entities_report_templates(workspace_id, async_req=True) >>> result = thread.get() Args: @@ -2374,7 +2295,7 @@ def get_all_entities_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutList + JsonApiReportTemplateOutList If the method is called asynchronously, returns the request thread. """ @@ -2405,27 +2326,32 @@ def get_all_entities_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - return self.get_all_entities_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_all_entities_report_templates_endpoint.call_with_http_info(**kwargs) - def get_all_entities_org_memory_items( + def get_all_entities_reports( self, + workspace_id, **kwargs ): - """Get all organization Memory Item entities # noqa: E501 + """Get all Reports # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_all_entities_org_memory_items(async_req=True) + >>> thread = api.get_all_entities_reports(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. @@ -2459,7 +2385,7 @@ def get_all_entities_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutList + JsonApiReportOutList If the method is called asynchronously, returns the request thread. """ @@ -2488,20 +2414,22 @@ def get_all_entities_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - return self.get_all_entities_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + return self.get_all_entities_reports_endpoint.call_with_http_info(**kwargs) - def get_entity_knowledge_recommendations( + def get_entity_report_page_layouts( self, workspace_id, object_id, **kwargs ): - """Get a Knowledge Recommendation # noqa: E501 + """Get a Report Page Layout # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.get_entity_knowledge_recommendations(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_report_page_layouts(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -2545,7 +2473,7 @@ def get_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2578,20 +2506,20 @@ def get_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def get_entity_memory_items( + def get_entity_report_templates( self, workspace_id, object_id, **kwargs ): - """Get a Memory Item # noqa: E501 + """Get a Report 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_memory_items(workspace_id, object_id, async_req=True) + >>> thread = api.get_entity_report_templates(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: @@ -2635,7 +2563,7 @@ def get_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2668,115 +2596,31 @@ def get_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - return self.get_entity_memory_items_endpoint.call_with_http_info(**kwargs) + return self.get_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def get_entity_org_memory_items( - self, - id, - **kwargs - ): - """Get an organization Memory Item entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_entity_org_memory_items(id, async_req=True) - >>> result = thread.get() - - Args: - id (str): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously - - Returns: - JsonApiOrgMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - return self.get_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - - def patch_entity_knowledge_recommendations( + def get_entity_reports( self, workspace_id, object_id, - json_api_knowledge_recommendation_patch_document, **kwargs ): - """Patch a Knowledge Recommendation # noqa: E501 + """Get a Report # 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_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_patch_document, async_req=True) + >>> thread = api.get_entity_reports(workspace_id, object_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_knowledge_recommendation_patch_document (JsonApiKnowledgeRecommendationPatchDocument): 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 @@ -2809,7 +2653,7 @@ def patch_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2842,29 +2686,27 @@ def patch_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_knowledge_recommendation_patch_document'] = \ - json_api_knowledge_recommendation_patch_document - return self.patch_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + return self.get_entity_reports_endpoint.call_with_http_info(**kwargs) - def patch_entity_memory_items( + def patch_entity_report_page_layouts( self, workspace_id, object_id, - json_api_memory_item_patch_document, + json_api_report_page_layout_patch_document, **kwargs ): - """Patch a Memory Item # noqa: E501 + """Patch a Report Page Layout # 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_memory_items(workspace_id, object_id, json_api_memory_item_patch_document, async_req=True) + >>> thread = api.patch_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_memory_item_patch_document (JsonApiMemoryItemPatchDocument): + json_api_report_page_layout_patch_document (JsonApiReportPageLayoutPatchDocument): 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] @@ -2901,7 +2743,7 @@ def patch_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -2934,119 +2776,33 @@ def patch_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_memory_item_patch_document'] = \ - json_api_memory_item_patch_document - return self.patch_entity_memory_items_endpoint.call_with_http_info(**kwargs) - - def patch_entity_org_memory_items( - self, - id, - json_api_org_memory_item_patch_document, - **kwargs - ): - """Patch an organization Memory Item entity # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.patch_entity_org_memory_items(id, json_api_org_memory_item_patch_document, async_req=True) - >>> result = thread.get() - - Args: - id (str): - json_api_org_memory_item_patch_document (JsonApiOrgMemoryItemPatchDocument): - - Keyword Args: - filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').. [optional] - include ([str]): Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.. [optional] - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _content_type (str/None): force body content-type. - Default is None and content-type will be predicted by allowed - content-types and body. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - _request_auths (list): set to override the auth_settings for an a single - request; this effectively ignores the authentication - in the spec for a single request. - Default is None - async_req (bool): execute request asynchronously + kwargs['json_api_report_page_layout_patch_document'] = \ + json_api_report_page_layout_patch_document + return self.patch_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - Returns: - JsonApiOrgMemoryItemOutDocument - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_spec_property_naming'] = kwargs.get( - '_spec_property_naming', False - ) - kwargs['_content_type'] = kwargs.get( - '_content_type') - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_org_memory_item_patch_document'] = \ - json_api_org_memory_item_patch_document - return self.patch_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) - - def search_entities_knowledge_recommendations( + def patch_entity_report_templates( self, workspace_id, - entity_search_body, + object_id, + json_api_report_template_patch_document, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """Patch a Report 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.search_entities_knowledge_recommendations(workspace_id, entity_search_body, async_req=True) + >>> thread = api.patch_entity_report_templates(workspace_id, object_id, json_api_report_template_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + object_id (str): + json_api_report_template_patch_document (JsonApiReportTemplatePatchDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 @@ -3079,7 +2835,7 @@ def search_entities_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutList + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -3110,31 +2866,35 @@ def search_entities_knowledge_recommendations( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + kwargs['json_api_report_template_patch_document'] = \ + json_api_report_template_patch_document + return self.patch_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def search_entities_memory_items( + def patch_entity_reports( self, workspace_id, - entity_search_body, + object_id, + json_api_report_patch_document, **kwargs ): - """The search endpoint (beta) # noqa: E501 + """Patch a Report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.search_entities_memory_items(workspace_id, entity_search_body, async_req=True) + >>> thread = api.patch_entity_reports(workspace_id, object_id, json_api_report_patch_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): - entity_search_body (EntitySearchBody): Search request body with filter, pagination, and sorting options + object_id (str): + json_api_report_patch_document (JsonApiReportPatchDocument): Keyword Args: - origin (str): [optional] if omitted the server will use the default value of "ALL" - x_gdc_validate_relations (bool): [optional] if omitted the server will use the default value of False + filter (str): Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, 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 @@ -3167,7 +2927,7 @@ def search_entities_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutList + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -3198,29 +2958,31 @@ def search_entities_memory_items( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['entity_search_body'] = \ - entity_search_body - return self.search_entities_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['object_id'] = \ + object_id + kwargs['json_api_report_patch_document'] = \ + json_api_report_patch_document + return self.patch_entity_reports_endpoint.call_with_http_info(**kwargs) - def update_entity_knowledge_recommendations( + def update_entity_report_page_layouts( self, workspace_id, object_id, - json_api_knowledge_recommendation_in_document, + json_api_report_page_layout_in_document, **kwargs ): - """Put a Knowledge Recommendation # noqa: E501 + """Put a Report Page Layout # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_knowledge_recommendations(workspace_id, object_id, json_api_knowledge_recommendation_in_document, async_req=True) + >>> thread = api.update_entity_report_page_layouts(workspace_id, object_id, json_api_report_page_layout_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_knowledge_recommendation_in_document (JsonApiKnowledgeRecommendationInDocument): + json_api_report_page_layout_in_document (JsonApiReportPageLayoutInDocument): 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] @@ -3257,7 +3019,7 @@ def update_entity_knowledge_recommendations( async_req (bool): execute request asynchronously Returns: - JsonApiKnowledgeRecommendationOutDocument + JsonApiReportPageLayoutOutDocument If the method is called asynchronously, returns the request thread. """ @@ -3290,29 +3052,29 @@ def update_entity_knowledge_recommendations( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_knowledge_recommendation_in_document'] = \ - json_api_knowledge_recommendation_in_document - return self.update_entity_knowledge_recommendations_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_page_layout_in_document'] = \ + json_api_report_page_layout_in_document + return self.update_entity_report_page_layouts_endpoint.call_with_http_info(**kwargs) - def update_entity_memory_items( + def update_entity_report_templates( self, workspace_id, object_id, - json_api_memory_item_in_document, + json_api_report_template_in_document, **kwargs ): - """Put a Memory Item # noqa: E501 + """Put a Report 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_memory_items(workspace_id, object_id, json_api_memory_item_in_document, async_req=True) + >>> thread = api.update_entity_report_templates(workspace_id, object_id, json_api_report_template_in_document, async_req=True) >>> result = thread.get() Args: workspace_id (str): object_id (str): - json_api_memory_item_in_document (JsonApiMemoryItemInDocument): + json_api_report_template_in_document (JsonApiReportTemplateInDocument): 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] @@ -3349,7 +3111,7 @@ def update_entity_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiMemoryItemOutDocument + JsonApiReportTemplateOutDocument If the method is called asynchronously, returns the request thread. """ @@ -3382,27 +3144,29 @@ def update_entity_memory_items( workspace_id kwargs['object_id'] = \ object_id - kwargs['json_api_memory_item_in_document'] = \ - json_api_memory_item_in_document - return self.update_entity_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['json_api_report_template_in_document'] = \ + json_api_report_template_in_document + return self.update_entity_report_templates_endpoint.call_with_http_info(**kwargs) - def update_entity_org_memory_items( + def update_entity_reports( self, - id, - json_api_org_memory_item_in_document, + workspace_id, + object_id, + json_api_report_in_document, **kwargs ): - """Put an organization Memory Item entity # noqa: E501 + """Put a Report # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.update_entity_org_memory_items(id, json_api_org_memory_item_in_document, async_req=True) + >>> thread = api.update_entity_reports(workspace_id, object_id, json_api_report_in_document, async_req=True) >>> result = thread.get() Args: - id (str): - json_api_org_memory_item_in_document (JsonApiOrgMemoryItemInDocument): + workspace_id (str): + object_id (str): + json_api_report_in_document (JsonApiReportInDocument): 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] @@ -3439,7 +3203,7 @@ def update_entity_org_memory_items( async_req (bool): execute request asynchronously Returns: - JsonApiOrgMemoryItemOutDocument + JsonApiReportOutDocument If the method is called asynchronously, returns the request thread. """ @@ -3468,9 +3232,11 @@ def update_entity_org_memory_items( '_content_type') kwargs['_host_index'] = kwargs.get('_host_index') kwargs['_request_auths'] = kwargs.get('_request_auths', None) - kwargs['id'] = \ - id - kwargs['json_api_org_memory_item_in_document'] = \ - json_api_org_memory_item_in_document - return self.update_entity_org_memory_items_endpoint.call_with_http_info(**kwargs) + kwargs['workspace_id'] = \ + workspace_id + kwargs['object_id'] = \ + object_id + kwargs['json_api_report_in_document'] = \ + json_api_report_in_document + return self.update_entity_reports_endpoint.call_with_http_info(**kwargs) diff --git a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py index 9faa9626e..d69d46a8b 100644 --- a/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py +++ b/gooddata-api-client/gooddata_api_client/api/smart_functions_api.py @@ -26,11 +26,6 @@ from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags 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.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse from gooddata_api_client.model.clustering_request import ClusteringRequest from gooddata_api_client.model.clustering_result import ClusteringResult from gooddata_api_client.model.forecast_request import ForecastRequest @@ -44,9 +39,6 @@ from gooddata_api_client.model.list_llm_provider_models_response import ListLlmProviderModelsResponse from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers from gooddata_api_client.model.quality_issues_calculation_status_response import QualityIssuesCalculationStatusResponse -from gooddata_api_client.model.resolved_llms import ResolvedLlms -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult from gooddata_api_client.model.smart_function_response import SmartFunctionResponse from gooddata_api_client.model.test_llm_provider_by_id_request import TestLlmProviderByIdRequest from gooddata_api_client.model.test_llm_provider_definition_request import TestLlmProviderDefinitionRequest @@ -68,7 +60,7 @@ def __init__(self, api_client=None): self.api_client = api_client self.ai_chat_endpoint = _Endpoint( settings={ - 'response_type': (ChatResult,), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chat', 'operation_id': 'ai_chat', @@ -78,11 +70,9 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', - 'chat_request', ], 'required': [ 'workspace_id', - 'chat_request', ], 'nullable': [ ], @@ -106,32 +96,25 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'chat_request': - (ChatRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'chat_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) self.ai_chat_history_endpoint = _Endpoint( settings={ - 'response_type': (ChatHistoryResult,), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory', 'operation_id': 'ai_chat_history', @@ -141,11 +124,9 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', - 'chat_history_request', ], 'required': [ 'workspace_id', - 'chat_history_request', ], 'nullable': [ ], @@ -169,32 +150,25 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'chat_history_request': - (ChatHistoryRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'chat_history_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) self.ai_chat_stream_endpoint = _Endpoint( settings={ - 'response_type': ([dict],), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatStream', 'operation_id': 'ai_chat_stream', @@ -204,11 +178,9 @@ def __init__(self, api_client=None): params_map={ 'all': [ 'workspace_id', - 'chat_request', ], 'required': [ 'workspace_id', - 'chat_request', ], 'nullable': [ ], @@ -232,32 +204,25 @@ def __init__(self, api_client=None): 'openapi_types': { 'workspace_id': (str,), - 'chat_request': - (ChatRequest,), }, 'attribute_map': { 'workspace_id': 'workspaceId', }, 'location_map': { 'workspace_id': 'path', - 'chat_request': 'body', }, 'collection_format_map': { } }, headers_map={ - 'accept': [ - 'text/event-stream' - ], - 'content_type': [ - 'application/json' - ] + 'accept': [], + 'content_type': [], }, api_client=api_client ) self.ai_chat_usage_endpoint = _Endpoint( settings={ - 'response_type': (ChatUsageResponse,), + 'response_type': None, 'auth': [], 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage', 'operation_id': 'ai_chat_usage', @@ -304,76 +269,11 @@ def __init__(self, api_client=None): } }, headers_map={ - 'accept': [ - 'application/json' - ], + 'accept': [], 'content_type': [], }, api_client=api_client ) - self.ai_search_endpoint = _Endpoint( - settings={ - 'response_type': (SearchResult,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/search', - 'operation_id': 'ai_search', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - 'search_request', - ], - 'required': [ - 'workspace_id', - 'search_request', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - 'search_request': - (SearchRequest,), - }, - 'attribute_map': { - 'workspace_id': 'workspaceId', - }, - 'location_map': { - 'workspace_id': 'path', - 'search_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,), @@ -1314,62 +1214,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.resolve_llm_providers_endpoint = _Endpoint( - settings={ - 'response_type': (ResolvedLlms,), - 'auth': [], - 'endpoint_path': '/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders', - 'operation_id': 'resolve_llm_providers', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'workspace_id', - ], - 'required': [ - 'workspace_id', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - 'workspace_id', - ] - }, - root_map={ - 'validations': { - ('workspace_id',): { - - 'regex': { - 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 - }, - }, - }, - 'allowed_values': { - }, - 'openapi_types': { - 'workspace_id': - (str,), - }, - '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.tags_endpoint = _Endpoint( settings={ 'response_type': (AnalyticsCatalogTags,), @@ -1727,21 +1571,19 @@ def __init__(self, api_client=None): def ai_chat( self, workspace_id, - chat_request, **kwargs ): - """(BETA) Chat with AI # noqa: E501 + """(REMOVED) Chat with AI # noqa: E501 - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 + Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.ai_chat(workspace_id, chat_request, async_req=True) + >>> thread = api.ai_chat(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - chat_request (ChatRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1776,7 +1618,7 @@ def ai_chat( async_req (bool): execute request asynchronously Returns: - ChatResult + None If the method is called asynchronously, returns the request thread. """ @@ -1807,28 +1649,24 @@ def ai_chat( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['chat_request'] = \ - chat_request return self.ai_chat_endpoint.call_with_http_info(**kwargs) def ai_chat_history( self, workspace_id, - chat_history_request, **kwargs ): - """(BETA) Get Chat History # noqa: E501 + """(REMOVED) Get Chat History # noqa: E501 - (BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history. # noqa: E501 + Removed. Chat history is served by the AI Assistant API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.ai_chat_history(workspace_id, chat_history_request, async_req=True) + >>> thread = api.ai_chat_history(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - chat_history_request (ChatHistoryRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1863,7 +1701,7 @@ def ai_chat_history( async_req (bool): execute request asynchronously Returns: - ChatHistoryResult + None If the method is called asynchronously, returns the request thread. """ @@ -1894,28 +1732,24 @@ def ai_chat_history( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['chat_history_request'] = \ - chat_history_request return self.ai_chat_history_endpoint.call_with_http_info(**kwargs) def ai_chat_stream( self, workspace_id, - chat_request, **kwargs ): - """(BETA) Chat with AI # noqa: E501 + """(REMOVED) Chat with AI # noqa: E501 - (BETA) Combines multiple use cases such as search, create visualizations, ... # noqa: E501 + Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True - >>> thread = api.ai_chat_stream(workspace_id, chat_request, async_req=True) + >>> thread = api.ai_chat_stream(workspace_id, async_req=True) >>> result = thread.get() Args: workspace_id (str): Workspace identifier - chat_request (ChatRequest): Keyword Args: _return_http_data_only (bool): response data without head status @@ -1950,7 +1784,7 @@ def ai_chat_stream( async_req (bool): execute request asynchronously Returns: - [dict] + None If the method is called asynchronously, returns the request thread. """ @@ -1981,8 +1815,6 @@ def ai_chat_stream( kwargs['_request_auths'] = kwargs.get('_request_auths', None) kwargs['workspace_id'] = \ workspace_id - kwargs['chat_request'] = \ - chat_request return self.ai_chat_stream_endpoint.call_with_http_info(**kwargs) def ai_chat_usage( @@ -1990,9 +1822,9 @@ def ai_chat_usage( workspace_id, **kwargs ): - """Get Chat Usage # noqa: E501 + """(REMOVED) Get Chat Usage # noqa: E501 - Returns usage statistics of chat for a user in a workspace. # noqa: E501 + Removed. Chat usage is served by the AI Assistant API. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2035,7 +1867,7 @@ def ai_chat_usage( async_req (bool): execute request asynchronously Returns: - ChatUsageResponse + None If the method is called asynchronously, returns the request thread. """ @@ -2068,93 +1900,6 @@ def ai_chat_usage( workspace_id return self.ai_chat_usage_endpoint.call_with_http_info(**kwargs) - def ai_search( - self, - workspace_id, - search_request, - **kwargs - ): - """(BETA) Semantic Search in Metadata # noqa: E501 - - (BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects. # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.ai_search(workspace_id, search_request, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - search_request (SearchRequest): - - 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: - SearchResult - 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['search_request'] = \ - search_request - return self.ai_search_endpoint.call_with_http_info(**kwargs) - def anomaly_detection( self, workspace_id, @@ -3457,89 +3202,6 @@ def resolve_llm_endpoints( workspace_id return self.resolve_llm_endpoints_endpoint.call_with_http_info(**kwargs) - def resolve_llm_providers( - self, - workspace_id, - **kwargs - ): - """Get Active LLM configuration for this workspace # noqa: E501 - - Resolves the active LLM provider configuration for the given 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.resolve_llm_providers(workspace_id, async_req=True) - >>> result = thread.get() - - Args: - workspace_id (str): Workspace identifier - - 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: - ResolvedLlms - 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.resolve_llm_providers_endpoint.call_with_http_info(**kwargs) - def tags( self, workspace_id, diff --git a/gooddata-api-client/gooddata_api_client/api/user_authorization_api.py b/gooddata-api-client/gooddata_api_client/api/user_authorization_api.py index 3185e9fb7..b1b2a90d0 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_authorization_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_authorization_api.py @@ -22,6 +22,7 @@ none_type, validate_and_convert_types ) +from gooddata_api_client.model.invitation import Invitation from gooddata_api_client.model.profile import Profile @@ -78,6 +79,54 @@ def __init__(self, api_client=None): }, api_client=api_client ) + self.process_invitation_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/api/v1/actions/invite', + 'operation_id': 'process_invitation', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'invitation', + ], + 'required': [ + 'invitation', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'invitation': + (Invitation,), + }, + 'attribute_map': { + }, + 'location_map': { + 'invitation': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) def get_profile( self, @@ -157,3 +206,86 @@ def get_profile( kwargs['_request_auths'] = kwargs.get('_request_auths', None) return self.get_profile_endpoint.call_with_http_info(**kwargs) + def process_invitation( + self, + invitation, + **kwargs + ): + """Invite User # noqa: E501 + + Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint. # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.process_invitation(invitation, async_req=True) + >>> result = thread.get() + + Args: + invitation (Invitation): + + 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['invitation'] = \ + invitation + return self.process_invitation_endpoint.call_with_http_info(**kwargs) + diff --git a/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py b/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py index 90bca8d5d..85a08f9fb 100644 --- a/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/user_data_filter_controller_api.py @@ -85,6 +85,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -245,6 +246,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -363,6 +365,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -462,6 +465,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", @@ -626,6 +630,7 @@ def __init__(self, api_client=None): "FACTS": "facts", "ATTRIBUTES": "attributes", "LABELS": "labels", + "COMPUTEDATTRIBUTES": "computedAttributes", "METRICS": "metrics", "DATASETS": "datasets", "PARAMETERS": "parameters", diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py index bac7dc353..10de02457 100644 --- a/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_api.py @@ -86,6 +86,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -94,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -246,6 +248,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -254,6 +257,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -364,6 +368,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -372,6 +377,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -463,6 +469,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -627,6 +634,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", diff --git a/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py b/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py index 4851ebed1..09b700df2 100644 --- a/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py +++ b/gooddata-api-client/gooddata_api_client/api/visualization_object_controller_api.py @@ -86,6 +86,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -94,6 +95,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -246,6 +248,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -254,6 +257,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "PAGE": "page", "ALL": "all", @@ -364,6 +368,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -372,6 +377,7 @@ def __init__(self, api_client=None): }, ('meta_include',): { + "PERMISSIONS": "permissions", "ORIGIN": "origin", "ALL": "all", "ALL": "ALL" @@ -463,6 +469,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", @@ -627,6 +634,7 @@ def __init__(self, api_client=None): "LABELS": "labels", "METRICS": "metrics", "PARAMETERS": "parameters", + "COMPUTEDATTRIBUTES": "computedAttributes", "DATASETS": "datasets", "CREATEDBY": "createdBy", "MODIFIEDBY": "modifiedBy", diff --git a/gooddata-api-client/gooddata_api_client/api_client.py b/gooddata-api-client/gooddata_api_client/api_client.py index 04c258c66..55d892184 100644 --- a/gooddata-api-client/gooddata_api_client/api_client.py +++ b/gooddata-api-client/gooddata_api_client/api_client.py @@ -804,11 +804,11 @@ def __call__(self, *args, **kwargs): """ This method is invoked when endpoints are called Example: - api_instance = AIApi() - api_instance.create_entity_knowledge_recommendations # this is an instance of the class Endpoint - api_instance.create_entity_knowledge_recommendations() # this invokes api_instance.create_entity_knowledge_recommendations.__call__() + api_instance = AILakeApi() + api_instance.add_ai_lake_database_data_source # this is an instance of the class Endpoint + api_instance.add_ai_lake_database_data_source() # this invokes api_instance.add_ai_lake_database_data_source.__call__() which then invokes the callable functions stored in that endpoint at - api_instance.create_entity_knowledge_recommendations.callable or self.callable in this class + api_instance.add_ai_lake_database_data_source.callable or self.callable in this class """ return self.callable(self, *args, **kwargs) diff --git a/gooddata-api-client/gooddata_api_client/apis/__init__.py b/gooddata-api-client/gooddata_api_client/apis/__init__.py index 39ee6bd20..a692450cf 100644 --- a/gooddata-api-client/gooddata_api_client/apis/__init__.py +++ b/gooddata-api-client/gooddata_api_client/apis/__init__.py @@ -6,7 +6,7 @@ # raise a `RecursionError`. # In order to avoid this, import only the API that you directly need like: # -# from gooddata_api_client.api.ai_api import AIApi +# from gooddata_api_client.api.ai_lake_api import AILakeApi # # or import this package, but before doing it, use: # @@ -14,14 +14,11 @@ # sys.setrecursionlimit(n) # Import APIs into API package: -from gooddata_api_client.api.ai_api import AIApi -from gooddata_api_client.api.ai_agents_api import AIAgentsApi from gooddata_api_client.api.ai_lake_api import AILakeApi from gooddata_api_client.api.ai_lake_databases_api import AILakeDatabasesApi -from gooddata_api_client.api.ai_lake_pipe_tables_api import AILakePipeTablesApi from gooddata_api_client.api.ai_lake_services_operations_api import AILakeServicesOperationsApi -from gooddata_api_client.api.ai_observability_api import AIObservabilityApi from gooddata_api_client.api.api_tokens_api import APITokensApi +from gooddata_api_client.api.agents_api import AgentsApi from gooddata_api_client.api.analytics_model_api import AnalyticsModelApi from gooddata_api_client.api.appearance_api import AppearanceApi from gooddata_api_client.api.attribute_hierarchies_api import AttributeHierarchiesApi @@ -32,6 +29,7 @@ from gooddata_api_client.api.cache_usage_api import CacheUsageApi from gooddata_api_client.api.certification_api import CertificationApi from gooddata_api_client.api.computation_api import ComputationApi +from gooddata_api_client.api.computed_attributes_api import ComputedAttributesApi from gooddata_api_client.api.cookie_security_configuration_api import CookieSecurityConfigurationApi from gooddata_api_client.api.dashboards_api import DashboardsApi from gooddata_api_client.api.data_filters_api import DataFiltersApi @@ -53,6 +51,7 @@ from gooddata_api_client.api.filter_context_api import FilterContextApi from gooddata_api_client.api.filter_views_api import FilterViewsApi from gooddata_api_client.api.fiscal_calendars_api import FiscalCalendarsApi +from gooddata_api_client.api.flow_api import FlowApi from gooddata_api_client.api.generate_logical_data_model_api import GenerateLogicalDataModelApi from gooddata_api_client.api.geographic_data_api import GeographicDataApi from gooddata_api_client.api.hierarchy_api import HierarchyApi @@ -60,14 +59,18 @@ from gooddata_api_client.api.image_export_api import ImageExportApi from gooddata_api_client.api.invalidate_cache_api import InvalidateCacheApi from gooddata_api_client.api.jwks_api import JWKSApi +from gooddata_api_client.api.knowledge_recommendations_api import KnowledgeRecommendationsApi from gooddata_api_client.api.ldm_declarative_apis_api import LDMDeclarativeAPIsApi 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.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 from gooddata_api_client.api.metrics_api import MetricsApi from gooddata_api_client.api.notification_channels_api import NotificationChannelsApi from gooddata_api_client.api.ogcapi_features_api import OGCAPIFeaturesApi +from gooddata_api_client.api.observability_api import ObservabilityApi from gooddata_api_client.api.options_api import OptionsApi from gooddata_api_client.api.organization_declarative_apis_api import OrganizationDeclarativeAPIsApi from gooddata_api_client.api.organization_entity_apis_api import OrganizationEntityAPIsApi @@ -75,7 +78,9 @@ from gooddata_api_client.api.permissions_api import PermissionsApi from gooddata_api_client.api.plugins_api import PluginsApi 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 +from gooddata_api_client.api.reports_api import ReportsApi from gooddata_api_client.api.scanning_api import ScanningApi from gooddata_api_client.api.slides_export_api import SlidesExportApi from gooddata_api_client.api.smart_functions_api import SmartFunctionsApi @@ -109,6 +114,7 @@ from gooddata_api_client.api.automation_organization_view_controller_api import AutomationOrganizationViewControllerApi from gooddata_api_client.api.automation_result_controller_api import AutomationResultControllerApi from gooddata_api_client.api.color_palette_controller_api import ColorPaletteControllerApi +from gooddata_api_client.api.computed_attribute_controller_api import ComputedAttributeControllerApi from gooddata_api_client.api.cookie_security_configuration_controller_api import CookieSecurityConfigurationControllerApi from gooddata_api_client.api.csp_directive_controller_api import CspDirectiveControllerApi from gooddata_api_client.api.custom_application_setting_controller_api import CustomApplicationSettingControllerApi @@ -141,6 +147,9 @@ from gooddata_api_client.api.organization_entity_controller_api import OrganizationEntityControllerApi from gooddata_api_client.api.organization_setting_controller_api import OrganizationSettingControllerApi from gooddata_api_client.api.parameter_controller_api import ParameterControllerApi +from gooddata_api_client.api.report_controller_api import ReportControllerApi +from gooddata_api_client.api.report_page_layout_controller_api import ReportPageLayoutControllerApi +from gooddata_api_client.api.report_template_controller_api import ReportTemplateControllerApi from gooddata_api_client.api.theme_controller_api import ThemeControllerApi from gooddata_api_client.api.user_controller_api import UserControllerApi from gooddata_api_client.api.user_data_filter_controller_api import UserDataFilterControllerApi diff --git a/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py b/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py index bb8ace11b..cdcccabbb 100644 --- a/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/absolute_granularity_date_filter_absolute_granularity_date_filter.py @@ -110,16 +110,6 @@ class AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter(ModelNormal): } validations = { - ('_from',): { - 'regex': { - 'pattern': r'^((?:\d{4})|(?:\d{4}-[1-4])|(?:\d{4}-(0[1-9]|1[0-2]))|(?:\d{4}-(0[1-9]|[1-4]\d|5[0-3]))|(?:\d{4}-\d{2}-\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,3}|[1-7]\d{4}|8[0-5]\d{3}|86[0-3]\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,2}|1[0-3]\d{2}|14[0-3]\d)|(?:[0-9]|1\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\d|3[01])|(?:[1-9]|[1-8]\d|9[0-2])|(?:[1-9]|[1-9]\d|[12]\d\d|3[0-5]\d|36[0-6])|(?:[1-9]|[1-4]\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$', # noqa: E501 - }, - }, - ('to',): { - 'regex': { - 'pattern': r'^((?:\d{4})|(?:\d{4}-[1-4])|(?:\d{4}-(0[1-9]|1[0-2]))|(?:\d{4}-(0[1-9]|[1-4]\d|5[0-3]))|(?:\d{4}-\d{2}-\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,3}|[1-7]\d{4}|8[0-5]\d{3}|86[0-3]\d{2})|(?:[0-9]|[1-5]\d)|(?:[0-9]|[1-9]\d{1,2}|1[0-3]\d{2}|14[0-3]\d)|(?:[0-9]|1\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\d|3[01])|(?:[1-9]|[1-8]\d|9[0-2])|(?:[1-9]|[1-9]\d|[12]\d\d|3[0-5]\d|36[0-6])|(?:[1-9]|[1-4]\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$', # noqa: E501 - }, - }, } @cached_property diff --git a/gooddata-api-client/gooddata_api_client/model/afm_flow_input.py b/gooddata-api-client/gooddata_api_client/model/afm_flow_input.py new file mode 100644 index 000000000..ac538b65f --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/afm_flow_input.py @@ -0,0 +1,337 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.afm import AFM + from gooddata_api_client.model.afm_flow_input_all_of import AfmFlowInputAllOf + from gooddata_api_client.model.execution_settings import ExecutionSettings + globals()['AFM'] = AFM + globals()['AfmFlowInputAllOf'] = AfmFlowInputAllOf + globals()['ExecutionSettings'] = ExecutionSettings + + +class AfmFlowInput(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',): { + 'AFM': "afm", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'execution': (AFM,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'settings': (ExecutionSettings,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'execution': 'execution', # noqa: E501 + 'type': 'type', # noqa: E501 + 'settings': 'settings', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """AfmFlowInput - a model defined in OpenAPI + + Keyword Args: + execution (AFM): + type (str): Type of the input.. defaults to "afm", must be one of ["afm", ] # 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,) + settings (ExecutionSettings): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "afm") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """AfmFlowInput - a model defined in OpenAPI + + Keyword Args: + execution (AFM): + type (str): Type of the input.. defaults to "afm", must be one of ["afm", ] # 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,) + settings (ExecutionSettings): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "afm") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + AfmFlowInputAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/random_distribution_config.py b/gooddata-api-client/gooddata_api_client/model/afm_flow_input_all_of.py similarity index 90% rename from gooddata-api-client/gooddata_api_client/model/random_distribution_config.py rename to gooddata-api-client/gooddata_api_client/model/afm_flow_input_all_of.py index 318a2f6f9..9a4cb8d08 100644 --- a/gooddata-api-client/gooddata_api_client/model/random_distribution_config.py +++ b/gooddata-api-client/gooddata_api_client/model/afm_flow_input_all_of.py @@ -30,8 +30,14 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.afm import AFM + from gooddata_api_client.model.execution_settings import ExecutionSettings + globals()['AFM'] = AFM + globals()['ExecutionSettings'] = ExecutionSettings -class RandomDistributionConfig(ModelNormal): + +class AfmFlowInputAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,14 +63,11 @@ class RandomDistributionConfig(ModelNormal): allowed_values = { ('type',): { - 'RANDOM': "random", + 'AFM': "afm", }, } validations = { - ('buckets',): { - 'inclusive_minimum': 1, - }, } @cached_property @@ -73,6 +76,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -87,9 +91,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { + 'execution': (AFM,), # noqa: E501 + 'settings': (ExecutionSettings,), # noqa: E501 'type': (str,), # noqa: E501 - 'buckets': (int,), # noqa: E501 } @cached_property @@ -98,8 +104,9 @@ def discriminator(): attribute_map = { + 'execution': 'execution', # noqa: E501 + 'settings': 'settings', # noqa: E501 'type': 'type', # noqa: E501 - 'buckets': 'buckets', # noqa: E501 } read_only_vars = { @@ -110,12 +117,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """RandomDistributionConfig - a model defined in OpenAPI - - Args: + """AfmFlowInputAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "random", must be one of ["random", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -146,10 +150,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 + execution (AFM): [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "afm" # noqa: E501 """ - type = kwargs.get('type', "random") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -179,7 +184,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -201,12 +205,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """RandomDistributionConfig - a model defined in OpenAPI - - Args: + """AfmFlowInputAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "random", must be one of ["random", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -237,10 +238,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 + execution (AFM): [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "afm" # noqa: E501 """ - type = kwargs.get('type', "random") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -268,7 +270,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py index 7effdae91..e4ab5929c 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py +++ b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_core_identifier.py @@ -61,6 +61,7 @@ class AfmObjectIdentifierCoreIdentifier(ModelNormal): 'LABEL': "label", 'FACT': "fact", 'METRIC': "metric", + 'COMPUTEDATTRIBUTE': "computedAttribute", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py index 957a62a3e..ae37df5c3 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py +++ b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_identifier.py @@ -59,6 +59,7 @@ class AfmObjectIdentifierIdentifier(ModelNormal): ('type',): { 'ANALYTICALDASHBOARD': "analyticalDashboard", 'ATTRIBUTE': "attribute", + 'COMPUTEDATTRIBUTE': "computedAttribute", 'DASHBOARDPLUGIN': "dashboardPlugin", 'DATASET': "dataset", 'FACT': "fact", diff --git a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py index 5837b784f..0c1dbac55 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py +++ b/gooddata-api-client/gooddata_api_client/model/afm_object_identifier_label_identifier.py @@ -58,6 +58,7 @@ class AfmObjectIdentifierLabelIdentifier(ModelNormal): allowed_values = { ('type',): { 'LABEL': "label", + 'COMPUTEDATTRIBUTE': "computedAttribute", }, } @@ -111,14 +112,14 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 """AfmObjectIdentifierLabelIdentifier - a model defined in OpenAPI Args: id (str): + type (str): Keyword Args: - type (str): defaults to "label", must be one of ["label", ] # 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. @@ -151,7 +152,6 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ - type = kwargs.get('type', "label") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -203,14 +203,14 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, *args, **kwargs): # noqa: E501 + def __init__(self, id, type, *args, **kwargs): # noqa: E501 """AfmObjectIdentifierLabelIdentifier - a model defined in OpenAPI Args: id (str): + type (str): Keyword Args: - type (str): defaults to "label", must be one of ["label", ] # 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. @@ -243,7 +243,6 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ - type = kwargs.get('type', "label") _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/afm_valid_objects_query.py b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.py index d83479183..4ca12373b 100644 --- a/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.py +++ b/gooddata-api-client/gooddata_api_client/model/afm_valid_objects_query.py @@ -64,6 +64,7 @@ class AfmValidObjectsQuery(ModelNormal): 'FACTS': "facts", 'ATTRIBUTES': "attributes", 'MEASURES': "measures", + 'COMPUTEDATTRIBUTES': "computedAttributes", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/ai_usage_metadata_item.py b/gooddata-api-client/gooddata_api_client/model/ai_usage_metadata_item.py deleted file mode 100644 index 2acd8baed..000000000 --- a/gooddata-api-client/gooddata_api_client/model/ai_usage_metadata_item.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AiUsageMetadataItem(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 { - 'counter_type': (str,), # noqa: E501 - 'current_value': (int,), # noqa: E501 - 'limit': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'counter_type': 'counterType', # noqa: E501 - 'current_value': 'currentValue', # noqa: E501 - 'limit': 'limit', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, counter_type, current_value, limit, *args, **kwargs): # noqa: E501 - """AiUsageMetadataItem - a model defined in OpenAPI - - Args: - counter_type (str): Type of usage counter, e.g. AI_QUERIES. - current_value (int): Current usage value after this request. - limit (int): Entitlement limit. 0 means unlimited. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.counter_type = counter_type - self.current_value = current_value - self.limit = limit - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, counter_type, current_value, limit, *args, **kwargs): # noqa: E501 - """AiUsageMetadataItem - a model defined in OpenAPI - - Args: - counter_type (str): Type of usage counter, e.g. AI_QUERIES. - current_value (int): Current usage value after this request. - limit (int): Entitlement limit. 0 means unlimited. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.counter_type = counter_type - self.current_value = current_value - self.limit = limit - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/allowed_relationship_type.py b/gooddata-api-client/gooddata_api_client/model/allowed_relationship_type.py deleted file mode 100644 index 17094fe69..000000000 --- a/gooddata-api-client/gooddata_api_client/model/allowed_relationship_type.py +++ /dev/null @@ -1,300 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class AllowedRelationshipType(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_type',): { - 'ATTRIBUTE': "attribute", - 'METRIC': "metric", - 'FACT': "fact", - 'LABEL': "label", - 'DATE': "date", - 'DATASET': "dataset", - 'VISUALIZATION': "visualization", - 'DASHBOARD': "dashboard", - }, - ('target_type',): { - 'ATTRIBUTE': "attribute", - 'METRIC': "metric", - 'FACT': "fact", - 'LABEL': "label", - 'DATE': "date", - 'DATASET': "dataset", - 'VISUALIZATION': "visualization", - 'DASHBOARD': "dashboard", - }, - } - - 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 { - 'source_type': (str,), # noqa: E501 - 'target_type': (str,), # noqa: E501 - 'allow_orphans': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'source_type': 'sourceType', # noqa: E501 - 'target_type': 'targetType', # noqa: E501 - 'allow_orphans': 'allowOrphans', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, source_type, target_type, *args, **kwargs): # noqa: E501 - """AllowedRelationshipType - a model defined in OpenAPI - - Args: - source_type (str): Source object type (e.g., 'dashboard', 'visualization', 'metric'). - target_type (str): Target object type (e.g., 'visualization', 'metric', 'attribute'). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allow_orphans (bool): If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).. [optional] if omitted the server will use the default value of True # 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.source_type = source_type - self.target_type = target_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, source_type, target_type, *args, **kwargs): # noqa: E501 - """AllowedRelationshipType - a model defined in OpenAPI - - Args: - source_type (str): Source object type (e.g., 'dashboard', 'visualization', 'metric'). - target_type (str): Target object type (e.g., 'visualization', 'metric', 'attribute'). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allow_orphans (bool): If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).. [optional] if omitted the server will use the default value of True # 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.source_type = source_type - self.target_type = target_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/attribute_negative_filter.py b/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.py deleted file mode 100644 index 17bf8fe2d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter.py +++ /dev/null @@ -1,327 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_negative_filter_all_of import AttributeNegativeFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['AttributeNegativeFilterAllOf'] = AttributeNegativeFilterAllOf - globals()['Filter'] = Filter - - -class AttributeNegativeFilter(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 { - 'exclude': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'exclude': 'exclude', # noqa: E501 - 'using': 'using', # noqa: E501 - } - - read_only_vars = { - } - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilter - a model defined in OpenAPI - - Keyword Args: - exclude ([str]): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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 - """AttributeNegativeFilter - a model defined in OpenAPI - - Keyword Args: - exclude ([str]): - using (str): - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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': [ - AttributeNegativeFilterAllOf, - Filter, - ], - 'oneOf': [ - ], - } diff --git a/gooddata-api-client/gooddata_api_client/model/automation_alert.py b/gooddata-api-client/gooddata_api_client/model/automation_alert.py index aac63158f..297c7325d 100644 --- a/gooddata-api-client/gooddata_api_client/model/automation_alert.py +++ b/gooddata-api-client/gooddata_api_client/model/automation_alert.py @@ -33,8 +33,10 @@ def lazy_import(): from gooddata_api_client.model.alert_afm import AlertAfm from gooddata_api_client.model.alert_condition import AlertCondition + from gooddata_api_client.model.execution_settings import ExecutionSettings globals()['AlertAfm'] = AlertAfm globals()['AlertCondition'] = AlertCondition + globals()['ExecutionSettings'] = ExecutionSettings class AutomationAlert(ModelNormal): @@ -105,6 +107,7 @@ def openapi_types(): 'condition': (AlertCondition,), # noqa: E501 'execution': (AlertAfm,), # noqa: E501 'interval': (str,), # noqa: E501 + 'settings': (ExecutionSettings,), # noqa: E501 'trigger': (str,), # noqa: E501 } @@ -117,6 +120,7 @@ def discriminator(): 'condition': 'condition', # noqa: E501 'execution': 'execution', # noqa: E501 'interval': 'interval', # noqa: E501 + 'settings': 'settings', # noqa: E501 'trigger': 'trigger', # noqa: E501 } @@ -166,6 +170,7 @@ def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E50 through its discriminator because we passed in _visited_composed_classes = (Animal,) interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ @@ -259,6 +264,7 @@ def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/certification_info.py b/gooddata-api-client/gooddata_api_client/model/certification_info.py deleted file mode 100644 index a66b1c74b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/certification_info.py +++ /dev/null @@ -1,274 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class CertificationInfo(ModelNormal): - """NOTE: This class is auto generated by OpenAPI Generator. - Ref: https://openapi-generator.tech - - Do not edit the class manually. - - Attributes: - allowed_values (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - with a capitalized key describing the allowed value and an allowed - value. These dicts store the allowed enum values. - attribute_map (dict): The key is attribute name - and the value is json key in definition. - discriminator_value_class_map (dict): A dict to go from the discriminator - variable value to the discriminator class name. - validations (dict): The key is the tuple path to the attribute - and the for var_name this is (var_name,). The value is a dict - that stores validations for max_length, min_length, max_items, - min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, - inclusive_minimum, and regex. - additional_properties_type (tuple): A tuple of classes accepted - as additional properties values. - """ - - allowed_values = { - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'status': (str,), # noqa: E501 - 'certification_message': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'status': 'status', # noqa: E501 - 'certification_message': 'certificationMessage', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, status, *args, **kwargs): # noqa: E501 - """CertificationInfo - a model defined in OpenAPI - - Args: - status (str): Certification status, e.g. CERTIFIED. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - certification_message (str): Optional message describing the certification.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, status, *args, **kwargs): # noqa: E501 - """CertificationInfo - a model defined in OpenAPI - - Args: - status (str): Certification status, e.g. CERTIFIED. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - certification_message (str): Optional message describing the certification.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/change_analysis_params.py b/gooddata-api-client/gooddata_api_client/model/change_analysis_params.py deleted file mode 100644 index 3be205599..000000000 --- a/gooddata-api-client/gooddata_api_client/model/change_analysis_params.py +++ /dev/null @@ -1,322 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.attribute_item import AttributeItem - from gooddata_api_client.model.filter_definition import FilterDefinition - from gooddata_api_client.model.measure_item import MeasureItem - globals()['AttributeItem'] = AttributeItem - globals()['FilterDefinition'] = FilterDefinition - globals()['MeasureItem'] = MeasureItem - - -class ChangeAnalysisParams(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 { - 'analyzed_period': (str,), # noqa: E501 - 'attributes': ([AttributeItem],), # noqa: E501 - 'date_attribute': (AttributeItem,), # noqa: E501 - 'filters': ([FilterDefinition],), # noqa: E501 - 'measure': (MeasureItem,), # noqa: E501 - 'measure_title': (str,), # noqa: E501 - 'reference_period': (str,), # noqa: E501 - 'use_smart_attribute_selection': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'analyzed_period': 'analyzedPeriod', # noqa: E501 - 'attributes': 'attributes', # noqa: E501 - 'date_attribute': 'dateAttribute', # noqa: E501 - 'filters': 'filters', # noqa: E501 - 'measure': 'measure', # noqa: E501 - 'measure_title': 'measureTitle', # noqa: E501 - 'reference_period': 'referencePeriod', # noqa: E501 - 'use_smart_attribute_selection': 'useSmartAttributeSelection', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, analyzed_period, attributes, date_attribute, filters, measure, measure_title, reference_period, use_smart_attribute_selection, *args, **kwargs): # noqa: E501 - """ChangeAnalysisParams - a model defined in OpenAPI - - Args: - analyzed_period (str): The analyzed time period - attributes ([AttributeItem]): Attributes to analyze for significant changes - date_attribute (AttributeItem): - filters ([FilterDefinition]): Optional filters to apply - measure (MeasureItem): - measure_title (str): The title of the measure being analyzed - reference_period (str): The reference time period - use_smart_attribute_selection (bool): Whether to use smart attribute selection - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.analyzed_period = analyzed_period - self.attributes = attributes - self.date_attribute = date_attribute - self.filters = filters - self.measure = measure - self.measure_title = measure_title - self.reference_period = reference_period - self.use_smart_attribute_selection = use_smart_attribute_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, analyzed_period, attributes, date_attribute, filters, measure, measure_title, reference_period, use_smart_attribute_selection, *args, **kwargs): # noqa: E501 - """ChangeAnalysisParams - a model defined in OpenAPI - - Args: - analyzed_period (str): The analyzed time period - attributes ([AttributeItem]): Attributes to analyze for significant changes - date_attribute (AttributeItem): - filters ([FilterDefinition]): Optional filters to apply - measure (MeasureItem): - measure_title (str): The title of the measure being analyzed - reference_period (str): The reference time period - use_smart_attribute_selection (bool): Whether to use smart attribute selection - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.analyzed_period = analyzed_period - self.attributes = attributes - self.date_attribute = date_attribute - self.filters = filters - self.measure = measure - self.measure_title = measure_title - self.reference_period = reference_period - self.use_smart_attribute_selection = use_smart_attribute_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/chat_history_interaction.py b/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py deleted file mode 100644 index 09b5dc740..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_interaction.py +++ /dev/null @@ -1,348 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.change_analysis_params import ChangeAnalysisParams - from gooddata_api_client.model.created_visualizations import CreatedVisualizations - from gooddata_api_client.model.found_objects import FoundObjects - from gooddata_api_client.model.reasoning import Reasoning - from gooddata_api_client.model.route_result import RouteResult - from gooddata_api_client.model.search_result import SearchResult - globals()['ChangeAnalysisParams'] = ChangeAnalysisParams - globals()['CreatedVisualizations'] = CreatedVisualizations - globals()['FoundObjects'] = FoundObjects - globals()['Reasoning'] = Reasoning - globals()['RouteResult'] = RouteResult - globals()['SearchResult'] = SearchResult - - -class ChatHistoryInteraction(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 = { - ('user_feedback',): { - 'POSITIVE': "POSITIVE", - 'NEGATIVE': "NEGATIVE", - 'NONE': "NONE", - }, - } - - validations = { - ('question',): { - 'max_length': 2000, - }, - } - - @cached_property - def additional_properties_type(): - """ - 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 { - 'chat_history_interaction_id': (str,), # noqa: E501 - 'interaction_finished': (bool,), # noqa: E501 - 'question': (str,), # noqa: E501 - 'routing': (RouteResult,), # noqa: E501 - 'change_analysis_params': (ChangeAnalysisParams,), # noqa: E501 - 'created_visualizations': (CreatedVisualizations,), # noqa: E501 - 'error_response': (str,), # noqa: E501 - 'found_objects': (FoundObjects,), # noqa: E501 - 'reasoning': (Reasoning,), # noqa: E501 - 'semantic_search': (SearchResult,), # noqa: E501 - 'text_response': (str,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'user_feedback': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'interaction_finished': 'interactionFinished', # noqa: E501 - 'question': 'question', # noqa: E501 - 'routing': 'routing', # noqa: E501 - 'change_analysis_params': 'changeAnalysisParams', # noqa: E501 - 'created_visualizations': 'createdVisualizations', # noqa: E501 - 'error_response': 'errorResponse', # noqa: E501 - 'found_objects': 'foundObjects', # noqa: E501 - 'reasoning': 'reasoning', # noqa: E501 - 'semantic_search': 'semanticSearch', # noqa: E501 - 'text_response': 'textResponse', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'user_feedback': 'userFeedback', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, chat_history_interaction_id, interaction_finished, question, routing, *args, **kwargs): # noqa: E501 - """ChatHistoryInteraction - a model defined in OpenAPI - - Args: - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction. - interaction_finished (bool): Has the interaction already finished? Can be used for polling when interaction is in progress. - question (str): User question - routing (RouteResult): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - change_analysis_params (ChangeAnalysisParams): [optional] # noqa: E501 - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - reasoning (Reasoning): [optional] # noqa: E501 - semantic_search (SearchResult): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [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.chat_history_interaction_id = chat_history_interaction_id - self.interaction_finished = interaction_finished - self.question = question - self.routing = routing - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, chat_history_interaction_id, interaction_finished, question, routing, *args, **kwargs): # noqa: E501 - """ChatHistoryInteraction - a model defined in OpenAPI - - Args: - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction. - interaction_finished (bool): Has the interaction already finished? Can be used for polling when interaction is in progress. - question (str): User question - routing (RouteResult): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - change_analysis_params (ChangeAnalysisParams): [optional] # noqa: E501 - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - reasoning (Reasoning): [optional] # noqa: E501 - semantic_search (SearchResult): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [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.chat_history_interaction_id = chat_history_interaction_id - self.interaction_finished = interaction_finished - self.question = question - self.routing = routing - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_request.py b/gooddata-api-client/gooddata_api_client/model/chat_request.py deleted file mode 100644 index a1d4264a4..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_request.py +++ /dev/null @@ -1,335 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.allowed_relationship_type import AllowedRelationshipType - from gooddata_api_client.model.user_context import UserContext - globals()['AllowedRelationshipType'] = AllowedRelationshipType - globals()['UserContext'] = UserContext - - -class ChatRequest(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 = { - ('object_types',): { - 'ATTRIBUTE': "attribute", - 'METRIC': "metric", - 'FACT': "fact", - 'LABEL': "label", - 'DATE': "date", - 'DATASET': "dataset", - 'VISUALIZATION': "visualization", - 'DASHBOARD': "dashboard", - }, - } - - validations = { - ('question',): { - 'max_length': 2000, - }, - } - - @cached_property - def additional_properties_type(): - """ - 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 { - 'question': (str,), # noqa: E501 - 'allowed_relationship_types': ([AllowedRelationshipType],), # noqa: E501 - 'include_hidden': (bool,), # noqa: E501 - 'limit_create': (int,), # noqa: E501 - 'limit_create_context': (int,), # noqa: E501 - 'limit_search': (int,), # noqa: E501 - 'object_types': ([str],), # noqa: E501 - 'relevant_score_threshold': (float,), # noqa: E501 - 'search_score_threshold': (float,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'title_to_descriptor_ratio': (float,), # noqa: E501 - 'user_context': (UserContext,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'question': 'question', # noqa: E501 - 'allowed_relationship_types': 'allowedRelationshipTypes', # noqa: E501 - 'include_hidden': 'includeHidden', # noqa: E501 - 'limit_create': 'limitCreate', # noqa: E501 - 'limit_create_context': 'limitCreateContext', # noqa: E501 - 'limit_search': 'limitSearch', # noqa: E501 - 'object_types': 'objectTypes', # noqa: E501 - 'relevant_score_threshold': 'relevantScoreThreshold', # noqa: E501 - 'search_score_threshold': 'searchScoreThreshold', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'title_to_descriptor_ratio': 'titleToDescriptorRatio', # noqa: E501 - 'user_context': 'userContext', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, question, *args, **kwargs): # noqa: E501 - """ChatRequest - a model defined in OpenAPI - - Args: - question (str): User question - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_relationship_types ([AllowedRelationshipType]): Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).. [optional] # noqa: E501 - include_hidden (bool): If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.. [optional] if omitted the server will use the default value of False # noqa: E501 - limit_create (int): Maximum number of created results.. [optional] if omitted the server will use the default value of 3 # noqa: E501 - limit_create_context (int): Maximum number of relevant objects included into context for LLM (for each object type).. [optional] if omitted the server will use the default value of 10 # noqa: E501 - limit_search (int): Maximum number of search results.. [optional] if omitted the server will use the default value of 5 # noqa: E501 - object_types ([str]): List of object types to filter the search and visualization building. If empty or null, all object types are considered.. [optional] # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.45 # noqa: E501 - search_score_threshold (float): Score, above which we return found object(s) and don't call LLM to create new objects.. [optional] if omitted the server will use the default value of 0.9 # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - user_context (UserContext): [optional] # noqa: E501 - """ - - _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.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, question, *args, **kwargs): # noqa: E501 - """ChatRequest - a model defined in OpenAPI - - Args: - question (str): User question - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_relationship_types ([AllowedRelationshipType]): Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).. [optional] # noqa: E501 - include_hidden (bool): If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.. [optional] if omitted the server will use the default value of False # noqa: E501 - limit_create (int): Maximum number of created results.. [optional] if omitted the server will use the default value of 3 # noqa: E501 - limit_create_context (int): Maximum number of relevant objects included into context for LLM (for each object type).. [optional] if omitted the server will use the default value of 10 # noqa: E501 - limit_search (int): Maximum number of search results.. [optional] if omitted the server will use the default value of 5 # noqa: E501 - object_types ([str]): List of object types to filter the search and visualization building. If empty or null, all object types are considered.. [optional] # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.45 # noqa: E501 - search_score_threshold (float): Score, above which we return found object(s) and don't call LLM to create new objects.. [optional] if omitted the server will use the default value of 0.9 # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - user_context (UserContext): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/chat_result.py b/gooddata-api-client/gooddata_api_client/model/chat_result.py deleted file mode 100644 index 9618f5b9a..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_result.py +++ /dev/null @@ -1,322 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.ai_usage_metadata_item import AiUsageMetadataItem - from gooddata_api_client.model.change_analysis_params import ChangeAnalysisParams - from gooddata_api_client.model.created_visualizations import CreatedVisualizations - from gooddata_api_client.model.found_objects import FoundObjects - from gooddata_api_client.model.reasoning import Reasoning - from gooddata_api_client.model.route_result import RouteResult - from gooddata_api_client.model.search_result import SearchResult - globals()['AiUsageMetadataItem'] = AiUsageMetadataItem - globals()['ChangeAnalysisParams'] = ChangeAnalysisParams - globals()['CreatedVisualizations'] = CreatedVisualizations - globals()['FoundObjects'] = FoundObjects - globals()['Reasoning'] = Reasoning - globals()['RouteResult'] = RouteResult - globals()['SearchResult'] = SearchResult - - -class ChatResult(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 { - 'change_analysis_params': (ChangeAnalysisParams,), # noqa: E501 - 'chat_history_interaction_id': (str,), # noqa: E501 - 'created_visualizations': (CreatedVisualizations,), # noqa: E501 - 'error_response': (str,), # noqa: E501 - 'found_objects': (FoundObjects,), # noqa: E501 - 'reasoning': (Reasoning,), # noqa: E501 - 'routing': (RouteResult,), # noqa: E501 - 'semantic_search': (SearchResult,), # noqa: E501 - 'text_response': (str,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'usage': ([AiUsageMetadataItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'change_analysis_params': 'changeAnalysisParams', # noqa: E501 - 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'created_visualizations': 'createdVisualizations', # noqa: E501 - 'error_response': 'errorResponse', # noqa: E501 - 'found_objects': 'foundObjects', # noqa: E501 - 'reasoning': 'reasoning', # noqa: E501 - 'routing': 'routing', # noqa: E501 - 'semantic_search': 'semanticSearch', # noqa: E501 - 'text_response': 'textResponse', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'usage': 'usage', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ChatResult - 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,) - change_analysis_params (ChangeAnalysisParams): [optional] # noqa: E501 - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction.. [optional] # noqa: E501 - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - reasoning (Reasoning): [optional] # noqa: E501 - routing (RouteResult): [optional] # noqa: E501 - semantic_search (SearchResult): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - usage ([AiUsageMetadataItem]): AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).. [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 - """ChatResult - 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,) - change_analysis_params (ChangeAnalysisParams): [optional] # noqa: E501 - chat_history_interaction_id (str): Chat History interaction ID. Unique ID for each interaction.. [optional] # noqa: E501 - created_visualizations (CreatedVisualizations): [optional] # noqa: E501 - error_response (str): Error response in anything fails.. [optional] # noqa: E501 - found_objects (FoundObjects): [optional] # noqa: E501 - reasoning (Reasoning): [optional] # noqa: E501 - routing (RouteResult): [optional] # noqa: E501 - semantic_search (SearchResult): [optional] # noqa: E501 - text_response (str): Text response for general questions.. [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - usage ([AiUsageMetadataItem]): AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).. [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/chat_usage_response.py b/gooddata-api-client/gooddata_api_client/model/chat_usage_response.py deleted file mode 100644 index 84fe2fd65..000000000 --- a/gooddata-api-client/gooddata_api_client/model/chat_usage_response.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ChatUsageResponse(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 { - 'interaction_count': (int,), # noqa: E501 - 'interaction_limit': (int,), # noqa: E501 - 'time_window_hours': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'interaction_count': 'interactionCount', # noqa: E501 - 'interaction_limit': 'interactionLimit', # noqa: E501 - 'time_window_hours': 'timeWindowHours', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, interaction_count, interaction_limit, time_window_hours, *args, **kwargs): # noqa: E501 - """ChatUsageResponse - a model defined in OpenAPI - - Args: - interaction_count (int): Number of interactions in the time window - interaction_limit (int): Maximum number of interactions in the time window any user can do in the workspace - time_window_hours (int): Time window in hours - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.interaction_count = interaction_count - self.interaction_limit = interaction_limit - self.time_window_hours = time_window_hours - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, interaction_count, interaction_limit, time_window_hours, *args, **kwargs): # noqa: E501 - """ChatUsageResponse - a model defined in OpenAPI - - Args: - interaction_count (int): Number of interactions in the time window - interaction_limit (int): Maximum number of interactions in the time window any user can do in the workspace - time_window_hours (int): Time window in hours - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.interaction_count = interaction_count - self.interaction_limit = interaction_limit - self.time_window_hours = time_window_hours - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/clustering_config.py b/gooddata-api-client/gooddata_api_client/model/clustering_config.py deleted file mode 100644 index f0777d585..000000000 --- a/gooddata-api-client/gooddata_api_client/model/clustering_config.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ClusteringConfig(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 { - 'number_of_clusters': (int,), # noqa: E501 - 'threshold': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'number_of_clusters': 'numberOfClusters', # noqa: E501 - 'threshold': 'threshold', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, number_of_clusters, threshold, *args, **kwargs): # noqa: E501 - """ClusteringConfig - a model defined in OpenAPI - - Args: - number_of_clusters (int): Number of clusters to create - threshold (float): Clustering algorithm threshold - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.number_of_clusters = number_of_clusters - self.threshold = threshold - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, number_of_clusters, threshold, *args, **kwargs): # noqa: E501 - """ClusteringConfig - a model defined in OpenAPI - - Args: - number_of_clusters (int): Number of clusters to create - threshold (float): Clustering algorithm threshold - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.number_of_clusters = number_of_clusters - self.threshold = threshold - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/clustering_result.py b/gooddata-api-client/gooddata_api_client/model/clustering_result.py index 1a966f7dc..e9c4a6426 100644 --- a/gooddata-api-client/gooddata_api_client/model/clustering_result.py +++ b/gooddata-api-client/gooddata_api_client/model/clustering_result.py @@ -84,10 +84,8 @@ def openapi_types(): return { 'attribute': ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}],), # noqa: E501 'clusters': ([int, none_type],), # noqa: E501 - 'xcoord': ([float],), # noqa: E501 - 'ycoord': ([float],), # noqa: E501 - 'x_coord': ([float, none_type],), # noqa: E501 - 'y_coord': ([float, none_type],), # noqa: E501 + 'xcoord': ([float, none_type],), # noqa: E501 + 'ycoord': ([float, none_type],), # noqa: E501 } @cached_property @@ -100,8 +98,6 @@ def discriminator(): 'clusters': 'clusters', # noqa: E501 'xcoord': 'xcoord', # noqa: E501 'ycoord': 'ycoord', # noqa: E501 - 'x_coord': 'xCoord', # noqa: E501 - 'y_coord': 'yCoord', # noqa: E501 } read_only_vars = { @@ -117,8 +113,8 @@ def _from_openapi_data(cls, attribute, clusters, xcoord, ycoord, *args, **kwargs Args: attribute ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): clusters ([int, none_type]): - xcoord ([float]): - ycoord ([float]): + xcoord ([float, none_type]): + ycoord ([float, none_type]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -151,8 +147,6 @@ def _from_openapi_data(cls, attribute, clusters, xcoord, ycoord, *args, **kwargs Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - x_coord ([float, none_type]): [optional] # noqa: E501 - y_coord ([float, none_type]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -214,8 +208,8 @@ def __init__(self, attribute, clusters, xcoord, ycoord, *args, **kwargs): # noq Args: attribute ([{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]): clusters ([int, none_type]): - xcoord ([float]): - ycoord ([float]): + xcoord ([float, none_type]): + ycoord ([float, none_type]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -248,8 +242,6 @@ def __init__(self, attribute, clusters, xcoord, ycoord, *args, **kwargs): # noq Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - x_coord ([float, none_type]): [optional] # noqa: E501 - y_coord ([float, none_type]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/column_expression.py b/gooddata-api-client/gooddata_api_client/model/column_expression.py deleted file mode 100644 index edfe55365..000000000 --- a/gooddata-api-client/gooddata_api_client/model/column_expression.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ColumnExpression(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 = { - ('function',): { - 'HLL_HASH': "HLL_HASH", - 'BITMAP_HASH': "BITMAP_HASH", - 'BITMAP_HASH64': "BITMAP_HASH64", - 'TO_BITMAP': "TO_BITMAP", - }, - } - - 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 { - 'column': (str,), # noqa: E501 - 'function': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column': 'column', # noqa: E501 - 'function': 'function', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column, function, *args, **kwargs): # noqa: E501 - """ColumnExpression - a model defined in OpenAPI - - Args: - column (str): Source column produced by parquet schema inference (after columnOverrides). - function (str): StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.column = column - self.function = function - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, column, function, *args, **kwargs): # noqa: E501 - """ColumnExpression - a model defined in OpenAPI - - Args: - column (str): Source column produced by parquet schema inference (after columnOverrides). - function (str): StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.column = column - self.function = function - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/found_objects.py b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions.py similarity index 87% rename from gooddata-api-client/gooddata_api_client/model/found_objects.py rename to gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions.py index acd206ff5..f010b50b8 100644 --- a/gooddata-api-client/gooddata_api_client/model/found_objects.py +++ b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions.py @@ -31,11 +31,15 @@ def lazy_import(): - from gooddata_api_client.model.search_result_object import SearchResultObject - globals()['SearchResultObject'] = SearchResultObject + from gooddata_api_client.model.rule_permission import RulePermission + from gooddata_api_client.model.user_group_permission import UserGroupPermission + from gooddata_api_client.model.user_permission import UserPermission + globals()['RulePermission'] = RulePermission + globals()['UserGroupPermission'] = UserGroupPermission + globals()['UserPermission'] = UserPermission -class FoundObjects(ModelNormal): +class ComputedAttributePermissions(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -88,8 +92,9 @@ def openapi_types(): """ lazy_import() return { - 'objects': ([SearchResultObject],), # noqa: E501 - 'reasoning': (str,), # noqa: E501 + 'rules': ([RulePermission],), # noqa: E501 + 'user_groups': ([UserGroupPermission],), # noqa: E501 + 'users': ([UserPermission],), # noqa: E501 } @cached_property @@ -98,8 +103,9 @@ def discriminator(): attribute_map = { - 'objects': 'objects', # noqa: E501 - 'reasoning': 'reasoning', # noqa: E501 + 'rules': 'rules', # noqa: E501 + 'user_groups': 'userGroups', # noqa: E501 + 'users': 'users', # noqa: E501 } read_only_vars = { @@ -109,12 +115,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, objects, reasoning, *args, **kwargs): # noqa: E501 - """FoundObjects - a model defined in OpenAPI + def _from_openapi_data(cls, rules, user_groups, users, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissions - a model defined in OpenAPI Args: - objects ([SearchResultObject]): List of objects found with a similarity search. - reasoning (str): DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. + rules ([RulePermission]): List of rules + user_groups ([UserGroupPermission]): List of user groups + users ([UserPermission]): List of users Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -178,8 +185,9 @@ def _from_openapi_data(cls, objects, reasoning, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.objects = objects - self.reasoning = reasoning + self.rules = rules + self.user_groups = user_groups + self.users = users for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -200,12 +208,13 @@ def _from_openapi_data(cls, objects, reasoning, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, objects, reasoning, *args, **kwargs): # noqa: E501 - """FoundObjects - a model defined in OpenAPI + def __init__(self, rules, user_groups, users, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissions - a model defined in OpenAPI Args: - objects ([SearchResultObject]): List of objects found with a similarity search. - reasoning (str): DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. + rules ([RulePermission]): List of rules + user_groups ([UserGroupPermission]): List of user groups + users ([UserPermission]): List of users Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -267,8 +276,9 @@ def __init__(self, objects, reasoning, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.objects = objects - self.reasoning = reasoning + self.rules = rules + self.user_groups = user_groups + self.users = users for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.py b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_assignment.py similarity index 94% rename from gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.py rename to gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_assignment.py index 40d6f718b..4accd003d 100644 --- a/gooddata-api-client/gooddata_api_client/model/anomaly_detection_config.py +++ b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_assignment.py @@ -31,7 +31,7 @@ -class AnomalyDetectionConfig(ModelNormal): +class ComputedAttributePermissionsAssignment(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,10 +56,10 @@ class AnomalyDetectionConfig(ModelNormal): """ allowed_values = { - ('sensitivity',): { - 'LOW': "LOW", - 'MEDIUM': "MEDIUM", - 'HIGH': "HIGH", + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", }, } @@ -87,7 +87,7 @@ def openapi_types(): and the value is attribute type. """ return { - 'sensitivity': (str,), # noqa: E501 + 'permissions': ([str],), # noqa: E501 } @cached_property @@ -96,7 +96,7 @@ def discriminator(): attribute_map = { - 'sensitivity': 'sensitivity', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 } read_only_vars = { @@ -106,11 +106,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, sensitivity, *args, **kwargs): # noqa: E501 - """AnomalyDetectionConfig - a model defined in OpenAPI + def _from_openapi_data(cls, permissions, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissionsAssignment - a model defined in OpenAPI Args: - sensitivity (str): Outlier sensitivity level. + permissions ([str]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -174,7 +174,7 @@ def _from_openapi_data(cls, sensitivity, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.sensitivity = sensitivity + self.permissions = permissions for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -195,11 +195,11 @@ def _from_openapi_data(cls, sensitivity, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, sensitivity, *args, **kwargs): # noqa: E501 - """AnomalyDetectionConfig - a model defined in OpenAPI + def __init__(self, permissions, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissionsAssignment - a model defined in OpenAPI Args: - sensitivity (str): Outlier sensitivity level. + permissions ([str]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -261,7 +261,7 @@ def __init__(self, sensitivity, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.sensitivity = sensitivity + self.permissions = permissions for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee.py new file mode 100644 index 000000000..34fcc9ae3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee.py @@ -0,0 +1,334 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier + from gooddata_api_client.model.attribute_permissions_for_assignee_all_of import AttributePermissionsForAssigneeAllOf + from gooddata_api_client.model.computed_attribute_permissions_assignment import ComputedAttributePermissionsAssignment + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AttributePermissionsForAssigneeAllOf'] = AttributePermissionsForAssigneeAllOf + globals()['ComputedAttributePermissionsAssignment'] = ComputedAttributePermissionsAssignment + + +class ComputedAttributePermissionsForAssignee(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'permissions': ([str],), # noqa: E501 + 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissionsForAssignee - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_identifier (AssigneeIdentifier): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissionsForAssignee - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_identifier (AssigneeIdentifier): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + AttributePermissionsForAssigneeAllOf, + ComputedAttributePermissionsAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee_rule.py new file mode 100644 index 000000000..0a735a790 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/computed_attribute_permissions_for_assignee_rule.py @@ -0,0 +1,334 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.assignee_rule import AssigneeRule + from gooddata_api_client.model.attribute_permissions_for_assignee_rule_all_of import AttributePermissionsForAssigneeRuleAllOf + from gooddata_api_client.model.computed_attribute_permissions_assignment import ComputedAttributePermissionsAssignment + globals()['AssigneeRule'] = AssigneeRule + globals()['AttributePermissionsForAssigneeRuleAllOf'] = AttributePermissionsForAssigneeRuleAllOf + globals()['ComputedAttributePermissionsAssignment'] = ComputedAttributePermissionsAssignment + + +class ComputedAttributePermissionsForAssigneeRule(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'permissions': ([str],), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_rule': 'assigneeRule', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissionsForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_rule (AssigneeRule): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ComputedAttributePermissionsForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_rule (AssigneeRule): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + AttributePermissionsForAssigneeRuleAllOf, + ComputedAttributePermissionsAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/chat_history_result.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting.py similarity index 90% rename from gooddata-api-client/gooddata_api_client/model/chat_history_result.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting.py index bb51900b6..08408a04d 100644 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_result.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.chat_history_interaction import ChatHistoryInteraction - globals()['ChatHistoryInteraction'] = ChatHistoryInteraction + from gooddata_api_client.model.conditional_formatting_rule import ConditionalFormattingRule + globals()['ConditionalFormattingRule'] = ConditionalFormattingRule -class ChatHistoryResult(ModelNormal): +class ConditionalFormatting(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -74,7 +74,7 @@ def additional_properties_type(): lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - _nullable = False + _nullable = True @cached_property def openapi_types(): @@ -88,8 +88,8 @@ def openapi_types(): """ lazy_import() return { - 'interactions': ([ChatHistoryInteraction],), # noqa: E501 - 'thread_id': (str,), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + 'rules': ([ConditionalFormattingRule],), # noqa: E501 } @cached_property @@ -98,8 +98,8 @@ def discriminator(): attribute_map = { - 'interactions': 'interactions', # noqa: E501 - 'thread_id': 'threadId', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + 'rules': 'rules', # noqa: E501 } read_only_vars = { @@ -109,12 +109,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, interactions, thread_id, *args, **kwargs): # noqa: E501 - """ChatHistoryResult - a model defined in OpenAPI + def _from_openapi_data(cls, enabled, rules, *args, **kwargs): # noqa: E501 + """ConditionalFormatting - a model defined in OpenAPI Args: - interactions ([ChatHistoryInteraction]): List of chat history interactions. - thread_id (str): The conversation thread ID. + enabled (bool): Whether the rules are applied when rendering. + rules ([ConditionalFormattingRule]): Rules evaluated in order; within a target, the first matching condition wins. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -178,8 +178,8 @@ def _from_openapi_data(cls, interactions, thread_id, *args, **kwargs): # noqa: self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.interactions = interactions - self.thread_id = thread_id + self.enabled = enabled + self.rules = rules for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -200,12 +200,12 @@ def _from_openapi_data(cls, interactions, thread_id, *args, **kwargs): # noqa: ]) @convert_js_args_to_python_args - def __init__(self, interactions, thread_id, *args, **kwargs): # noqa: E501 - """ChatHistoryResult - a model defined in OpenAPI + def __init__(self, enabled, rules, *args, **kwargs): # noqa: E501 + """ConditionalFormatting - a model defined in OpenAPI Args: - interactions ([ChatHistoryInteraction]): List of chat history interactions. - thread_id (str): The conversation thread ID. + enabled (bool): Whether the rules are applied when rendering. + rules ([ConditionalFormattingRule]): Rules evaluated in order; within a target, the first matching condition wins. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -267,8 +267,8 @@ def __init__(self, interactions, thread_id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.interactions = interactions - self.thread_id = thread_id + self.enabled = enabled + self.rules = rules 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/create_pipe_table_request_key_config.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_absolute_date_value.py similarity index 89% rename from gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_key_config.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_absolute_date_value.py index 2d422e918..5b69c10b2 100644 --- a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_absolute_date_value.py @@ -31,17 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.aggregate_key_config import AggregateKeyConfig - from gooddata_api_client.model.duplicate_key_config import DuplicateKeyConfig - from gooddata_api_client.model.primary_key_config import PrimaryKeyConfig - from gooddata_api_client.model.unique_key_config import UniqueKeyConfig - globals()['AggregateKeyConfig'] = AggregateKeyConfig - globals()['DuplicateKeyConfig'] = DuplicateKeyConfig - globals()['PrimaryKeyConfig'] = PrimaryKeyConfig - globals()['UniqueKeyConfig'] = UniqueKeyConfig + from gooddata_api_client.model.conditional_formatting_absolute_date_value_all_of import ConditionalFormattingAbsoluteDateValueAllOf + globals()['ConditionalFormattingAbsoluteDateValueAllOf'] = ConditionalFormattingAbsoluteDateValueAllOf -class CreatePipeTableRequestKeyConfig(ModelComposed): +class ConditionalFormattingAbsoluteDateValue(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -66,8 +60,8 @@ class CreatePipeTableRequestKeyConfig(ModelComposed): """ allowed_values = { - ('type',): { - 'UNIQUE': "unique", + ('kind',): { + 'ABSOLUTEDATE': "absoluteDate", }, } @@ -97,8 +91,9 @@ def openapi_types(): """ lazy_import() return { - 'columns': ([str],), # noqa: E501 - 'type': (str,), # noqa: E501 + '_from': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'to': (str,), # noqa: E501 } @cached_property @@ -107,8 +102,9 @@ def discriminator(): attribute_map = { - 'columns': 'columns', # noqa: E501 - 'type': 'type', # noqa: E501 + '_from': 'from', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'to': 'to', # noqa: E501 } read_only_vars = { @@ -117,9 +113,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequestKeyConfig - a model defined in OpenAPI + """ConditionalFormattingAbsoluteDateValue - a model defined in OpenAPI Keyword Args: + _from (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. + kind (str): The value kind.. defaults to "absoluteDate", must be one of ["absoluteDate", ] # noqa: E501 + to (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. 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. @@ -150,10 +149,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "unique" # noqa: E501 """ + kind = kwargs.get('kind', "absoluteDate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -222,9 +220,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequestKeyConfig - a model defined in OpenAPI + """ConditionalFormattingAbsoluteDateValue - a model defined in OpenAPI Keyword Args: + _from (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. + kind (str): The value kind.. defaults to "absoluteDate", must be one of ["absoluteDate", ] # noqa: E501 + to (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. 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. @@ -255,10 +256,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "unique" # noqa: E501 """ + kind = kwargs.get('kind', "absoluteDate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -326,11 +326,8 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ + ConditionalFormattingAbsoluteDateValueAllOf, ], 'oneOf': [ - AggregateKeyConfig, - DuplicateKeyConfig, - PrimaryKeyConfig, - UniqueKeyConfig, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_absolute_date_value_all_of.py similarity index 89% rename from gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter_all_of.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_absolute_date_value_all_of.py index dc8a8267f..7892d4963 100644 --- a/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_absolute_date_value_all_of.py @@ -31,7 +31,7 @@ -class GenAiRankingFilterAllOf(ModelNormal): +class ConditionalFormattingAbsoluteDateValueAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,9 +56,8 @@ class GenAiRankingFilterAllOf(ModelNormal): """ allowed_values = { - ('operator',): { - 'TOP': "TOP", - 'BOTTOM': "BOTTOM", + ('kind',): { + 'ABSOLUTEDATE': "absoluteDate", }, } @@ -86,10 +85,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'dimensionality': ([str],), # noqa: E501 - 'measures': ([str],), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'value': (int,), # noqa: E501 + '_from': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'to': (str,), # noqa: E501 } @cached_property @@ -98,10 +96,9 @@ def discriminator(): attribute_map = { - 'dimensionality': 'dimensionality', # noqa: E501 - 'measures': 'measures', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'value': 'value', # noqa: E501 + '_from': 'from', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'to': 'to', # noqa: E501 } read_only_vars = { @@ -112,7 +109,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """GenAiRankingFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingAbsoluteDateValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -145,10 +142,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dimensionality ([str]): [optional] # noqa: E501 - measures ([str]): [optional] # noqa: E501 - operator (str): [optional] # noqa: E501 - value (int): [optional] # noqa: E501 + _from (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.. [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "absoluteDate" # noqa: E501 + to (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -201,7 +197,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """GenAiRankingFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingAbsoluteDateValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -234,10 +230,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dimensionality ([str]): [optional] # noqa: E501 - measures ([str]): [optional] # noqa: E501 - operator (str): [optional] # noqa: E501 - value (int): [optional] # noqa: E501 + _from (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.. [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "absoluteDate" # noqa: E501 + to (str): `YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm_provider.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_attribute_target.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/resolved_llm_provider.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_attribute_target.py index 741027bcc..167ce3a8b 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llm_provider.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_attribute_target.py @@ -31,15 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.llm_model import LlmModel - from gooddata_api_client.model.resolved_llm import ResolvedLlm - from gooddata_api_client.model.resolved_llm_provider_all_of import ResolvedLlmProviderAllOf - globals()['LlmModel'] = LlmModel - globals()['ResolvedLlm'] = ResolvedLlm - globals()['ResolvedLlmProviderAllOf'] = ResolvedLlmProviderAllOf + from gooddata_api_client.model.conditional_formatting_attribute_target_all_of import ConditionalFormattingAttributeTargetAllOf + globals()['ConditionalFormattingAttributeTargetAllOf'] = ConditionalFormattingAttributeTargetAllOf -class ResolvedLlmProvider(ModelComposed): +class ConditionalFormattingAttributeTarget(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -64,13 +60,12 @@ class ResolvedLlmProvider(ModelComposed): """ allowed_values = { + ('kind',): { + 'ATTRIBUTE': "attribute", + }, } validations = { - ('models',): { - 'max_items': 1, - 'min_items': 1, - }, } @cached_property @@ -96,9 +91,8 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'models': ([LlmModel],), # noqa: E501 + 'attribute_identifier': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 } @cached_property @@ -107,9 +101,8 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'models': 'models', # noqa: E501 + 'attribute_identifier': 'attributeIdentifier', # noqa: E501 + 'kind': 'kind', # noqa: E501 } read_only_vars = { @@ -118,12 +111,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResolvedLlmProvider - a model defined in OpenAPI + """ConditionalFormattingAttributeTarget - a model defined in OpenAPI Keyword Args: - id (str): Provider Id - title (str): Provider Title - models ([LlmModel]): + attribute_identifier (str): + kind (str): The target kind.. defaults to "attribute", must be one of ["attribute", ] # 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. @@ -156,6 +148,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + kind = kwargs.get('kind', "attribute") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -224,12 +217,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ResolvedLlmProvider - a model defined in OpenAPI + """ConditionalFormattingAttributeTarget - a model defined in OpenAPI Keyword Args: - id (str): Provider Id - title (str): Provider Title - models ([LlmModel]): + attribute_identifier (str): + kind (str): The target kind.. defaults to "attribute", must be one of ["attribute", ] # 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. @@ -262,6 +254,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + kind = kwargs.get('kind', "attribute") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -329,8 +322,7 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ - ResolvedLlm, - ResolvedLlmProviderAllOf, + ConditionalFormattingAttributeTargetAllOf, ], 'oneOf': [ ], diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_attribute_target_all_of.py similarity index 92% rename from gooddata-api-client/gooddata_api_client/model/attribute_negative_filter_all_of.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_attribute_target_all_of.py index 5de3703ba..27cc4876d 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_negative_filter_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_attribute_target_all_of.py @@ -31,7 +31,7 @@ -class AttributeNegativeFilterAllOf(ModelNormal): +class ConditionalFormattingAttributeTargetAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,6 +56,9 @@ class AttributeNegativeFilterAllOf(ModelNormal): """ allowed_values = { + ('kind',): { + 'ATTRIBUTE': "attribute", + }, } validations = { @@ -82,8 +85,8 @@ def openapi_types(): and the value is attribute type. """ return { - 'exclude': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 + 'attribute_identifier': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 } @cached_property @@ -92,8 +95,8 @@ def discriminator(): attribute_map = { - 'exclude': 'exclude', # noqa: E501 - 'using': 'using', # noqa: E501 + 'attribute_identifier': 'attributeIdentifier', # noqa: E501 + 'kind': 'kind', # noqa: E501 } read_only_vars = { @@ -104,7 +107,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingAttributeTargetAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -137,8 +140,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + attribute_identifier (str): [optional] # noqa: E501 + kind (str): The target kind.. [optional] if omitted the server will use the default value of "attribute" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -191,7 +194,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """AttributeNegativeFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingAttributeTargetAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -224,8 +227,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + attribute_identifier (str): [optional] # noqa: E501 + kind (str): The target kind.. [optional] if omitted the server will use the default value of "attribute" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/conditional_formatting_condition.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_condition.py new file mode 100644 index 000000000..f86f6941e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_condition.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.conditional_formatting_format import ConditionalFormattingFormat + from gooddata_api_client.model.conditional_formatting_value import ConditionalFormattingValue + globals()['ConditionalFormattingFormat'] = ConditionalFormattingFormat + globals()['ConditionalFormattingValue'] = ConditionalFormattingValue + + +class ConditionalFormattingCondition(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',): { + 'ALL': "ALL", + 'GREATER_THAN': "GREATER_THAN", + 'GREATER_THAN_OR_EQUAL_TO': "GREATER_THAN_OR_EQUAL_TO", + 'LESS_THAN': "LESS_THAN", + 'LESS_THAN_OR_EQUAL_TO': "LESS_THAN_OR_EQUAL_TO", + 'EQUAL_TO': "EQUAL_TO", + 'NOT_EQUAL_TO': "NOT_EQUAL_TO", + 'BETWEEN': "BETWEEN", + 'NOT_BETWEEN': "NOT_BETWEEN", + 'CONTAINS': "CONTAINS", + 'NOT_CONTAINS': "NOT_CONTAINS", + 'STARTS_WITH': "STARTS_WITH", + 'NOT_STARTS_WITH': "NOT_STARTS_WITH", + 'ENDS_WITH': "ENDS_WITH", + 'NOT_ENDS_WITH': "NOT_ENDS_WITH", + 'IS_EMPTY': "IS_EMPTY", + 'IS_NOT_EMPTY': "IS_NOT_EMPTY", + }, + } + + 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 { + 'format': (ConditionalFormattingFormat,), # noqa: E501 + 'operator': (str,), # noqa: E501 + 'value': (ConditionalFormattingValue,), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'format': 'format', # noqa: E501 + 'operator': 'operator', # noqa: E501 + 'value': 'value', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, format, operator, value, *args, **kwargs): # noqa: E501 + """ConditionalFormattingCondition - a model defined in OpenAPI + + Args: + format (ConditionalFormattingFormat): + operator (str): How a condition compares the cell value against its value. + value (ConditionalFormattingValue): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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): Client-assigned identifier, stable across edits.. [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.format = format + self.operator = operator + 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, format, operator, value, *args, **kwargs): # noqa: E501 + """ConditionalFormattingCondition - a model defined in OpenAPI + + Args: + format (ConditionalFormattingFormat): + operator (str): How a condition compares the cell value against its value. + value (ConditionalFormattingValue): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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): Client-assigned identifier, stable across edits.. [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.format = format + self.operator = operator + 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/column_partition_config.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_format.py similarity index 89% rename from gooddata-api-client/gooddata_api_client/model/column_partition_config.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_format.py index d2ee4e282..f76792413 100644 --- a/gooddata-api-client/gooddata_api_client/model/column_partition_config.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_format.py @@ -31,7 +31,7 @@ -class ColumnPartitionConfig(ModelNormal): +class ConditionalFormattingFormat(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,8 +56,9 @@ class ColumnPartitionConfig(ModelNormal): """ allowed_values = { - ('type',): { - 'COLUMN': "column", + ('scope',): { + 'CELL': "cell", + 'ROW': "row", }, } @@ -85,8 +86,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'columns': ([str],), # noqa: E501 - 'type': (str,), # noqa: E501 + 'scope': (str,), # noqa: E501 + 'background_color': (str,), # noqa: E501 + 'color': (str,), # noqa: E501 } @cached_property @@ -95,8 +97,9 @@ def discriminator(): attribute_map = { - 'columns': 'columns', # noqa: E501 - 'type': 'type', # noqa: E501 + 'scope': 'scope', # noqa: E501 + 'background_color': 'backgroundColor', # noqa: E501 + 'color': 'color', # noqa: E501 } read_only_vars = { @@ -106,14 +109,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 - """ColumnPartitionConfig - a model defined in OpenAPI + def _from_openapi_data(cls, scope, *args, **kwargs): # noqa: E501 + """ConditionalFormattingFormat - a model defined in OpenAPI Args: - columns ([str]): Columns to partition by. + scope (str): Whether the formatting applies to the matching cell only, or to its whole row. 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. @@ -144,9 +146,10 @@ def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + background_color (str): Background color as a hex triplet.. [optional] # noqa: E501 + color (str): Text color as a hex triplet.. [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', ()) @@ -176,8 +179,7 @@ def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.columns = columns - self.type = type + self.scope = scope for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,14 +200,13 @@ def _from_openapi_data(cls, columns, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, columns, *args, **kwargs): # noqa: E501 - """ColumnPartitionConfig - a model defined in OpenAPI + def __init__(self, scope, *args, **kwargs): # noqa: E501 + """ConditionalFormattingFormat - a model defined in OpenAPI Args: - columns ([str]): Columns to partition by. + scope (str): Whether the formatting applies to the matching cell only, or to its whole row. 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. @@ -236,9 +237,10 @@ def __init__(self, columns, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + background_color (str): Background color as a hex triplet.. [optional] # noqa: E501 + color (str): Text color as a hex triplet.. [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', ()) @@ -266,8 +268,7 @@ def __init__(self, columns, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.columns = columns - self.type = type + self.scope = scope 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/filter.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal.py similarity index 98% rename from gooddata-api-client/gooddata_api_client/model/filter.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal.py index 160e2d9f3..03ba372b1 100644 --- a/gooddata-api-client/gooddata_api_client/model/filter.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal.py @@ -31,7 +31,7 @@ -class Filter(ModelNormal): +class ConditionalFormattingLiteral(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -100,7 +100,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """Filter - a model defined in OpenAPI + """ConditionalFormattingLiteral - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -185,7 +185,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """Filter - a model defined in OpenAPI + """ConditionalFormattingLiteral - 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/conditional_formatting_literal_range_value.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_range_value.py new file mode 100644 index 000000000..68c5f9444 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_range_value.py @@ -0,0 +1,333 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + 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.conditional_formatting_literal_range_value_all_of import ConditionalFormattingLiteralRangeValueAllOf + globals()['ConditionalFormattingLiteralRangeValueAllOf'] = ConditionalFormattingLiteralRangeValueAllOf + + +class ConditionalFormattingLiteralRangeValue(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 = { + ('kind',): { + 'LITERALRANGE': "literalRange", + }, + } + + 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 { + '_from': (float,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'to': (float,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + '_from': 'from', # noqa: E501 + 'kind': 'kind', # 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 + """ConditionalFormattingLiteralRangeValue - a model defined in OpenAPI + + Keyword Args: + _from (float): + kind (str): The value kind.. defaults to "literalRange", must be one of ["literalRange", ] # noqa: E501 + to (float): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + kind = kwargs.get('kind', "literalRange") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """ConditionalFormattingLiteralRangeValue - a model defined in OpenAPI + + Keyword Args: + _from (float): + kind (str): The value kind.. defaults to "literalRange", must be one of ["literalRange", ] # noqa: E501 + to (float): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + kind = kwargs.get('kind', "literalRange") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + ConditionalFormattingLiteralRangeValueAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_range_value_all_of.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_range_value_all_of.py index 7c903e928..1c55eb269 100644 --- a/gooddata-api-client/gooddata_api_client/model/aggregate_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_range_value_all_of.py @@ -31,7 +31,7 @@ -class AggregateKeyConfig(ModelNormal): +class ConditionalFormattingLiteralRangeValueAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,8 +56,8 @@ class AggregateKeyConfig(ModelNormal): """ allowed_values = { - ('type',): { - 'AGGREGATE': "aggregate", + ('kind',): { + 'LITERALRANGE': "literalRange", }, } @@ -85,8 +85,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'type': (str,), # noqa: E501 - 'columns': ([str],), # noqa: E501 + '_from': (float,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'to': (float,), # noqa: E501 } @cached_property @@ -95,8 +96,9 @@ def discriminator(): attribute_map = { - 'type': 'type', # noqa: E501 - 'columns': 'columns', # noqa: E501 + '_from': 'from', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'to': 'to', # noqa: E501 } read_only_vars = { @@ -107,12 +109,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AggregateKeyConfig - a model defined in OpenAPI - - Args: + """ConditionalFormattingLiteralRangeValueAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "aggregate", must be one of ["aggregate", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -143,10 +142,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + _from (float): [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "literalRange" # noqa: E501 + to (float): [optional] # noqa: E501 """ - type = kwargs.get('type', "aggregate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -176,7 +176,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,12 +197,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """AggregateKeyConfig - a model defined in OpenAPI - - Args: + """ConditionalFormattingLiteralRangeValueAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "aggregate", must be one of ["aggregate", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -234,10 +230,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + _from (float): [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "literalRange" # noqa: E501 + to (float): [optional] # noqa: E501 """ - type = kwargs.get('type', "aggregate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -265,7 +262,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value.py new file mode 100644 index 000000000..ecb44f1d0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value.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.conditional_formatting_literal import ConditionalFormattingLiteral + from gooddata_api_client.model.conditional_formatting_literal_value_all_of import ConditionalFormattingLiteralValueAllOf + globals()['ConditionalFormattingLiteral'] = ConditionalFormattingLiteral + globals()['ConditionalFormattingLiteralValueAllOf'] = ConditionalFormattingLiteralValueAllOf + + +class ConditionalFormattingLiteralValue(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 = { + ('kind',): { + 'LITERAL': "literal", + }, + } + + 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 { + 'kind': (str,), # noqa: E501 + 'value': (ConditionalFormattingLiteral,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'kind': 'kind', # noqa: E501 + 'value': 'value', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConditionalFormattingLiteralValue - a model defined in OpenAPI + + Keyword Args: + kind (str): The value kind.. defaults to "literal", must be one of ["literal", ] # noqa: E501 + value (ConditionalFormattingLiteral): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + kind = kwargs.get('kind', "literal") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """ConditionalFormattingLiteralValue - a model defined in OpenAPI + + Keyword Args: + kind (str): The value kind.. defaults to "literal", must be one of ["literal", ] # noqa: E501 + value (ConditionalFormattingLiteral): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + kind = kwargs.get('kind', "literal") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + ConditionalFormattingLiteralValueAllOf, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm_provider_all_of.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value_all_of.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/resolved_llm_provider_all_of.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value_all_of.py index 31850a9bb..cccf838d6 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llm_provider_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_literal_value_all_of.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.llm_model import LlmModel - globals()['LlmModel'] = LlmModel + from gooddata_api_client.model.conditional_formatting_literal import ConditionalFormattingLiteral + globals()['ConditionalFormattingLiteral'] = ConditionalFormattingLiteral -class ResolvedLlmProviderAllOf(ModelNormal): +class ConditionalFormattingLiteralValueAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -60,13 +60,12 @@ class ResolvedLlmProviderAllOf(ModelNormal): """ allowed_values = { + ('kind',): { + 'LITERAL': "literal", + }, } validations = { - ('models',): { - 'max_items': 1, - 'min_items': 1, - }, } @cached_property @@ -92,9 +91,8 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'models': ([LlmModel],), # noqa: E501 - 'title': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'value': (ConditionalFormattingLiteral,), # noqa: E501 } @cached_property @@ -103,9 +101,8 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'models': 'models', # noqa: E501 - 'title': 'title', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'value': 'value', # noqa: E501 } read_only_vars = { @@ -116,7 +113,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResolvedLlmProviderAllOf - a model defined in OpenAPI + """ConditionalFormattingLiteralValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -149,9 +146,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - id (str): Provider Id. [optional] # noqa: E501 - models ([LlmModel]): [optional] # noqa: E501 - title (str): Provider Title. [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "literal" # noqa: E501 + value (ConditionalFormattingLiteral): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -204,7 +200,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ResolvedLlmProviderAllOf - a model defined in OpenAPI + """ConditionalFormattingLiteralValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -237,9 +233,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - id (str): Provider Id. [optional] # noqa: E501 - models ([LlmModel]): [optional] # noqa: E501 - title (str): Provider Title. [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "literal" # noqa: E501 + value (ConditionalFormattingLiteral): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llms_data.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_measure_target.py similarity index 92% rename from gooddata-api-client/gooddata_api_client/model/resolved_llms_data.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_measure_target.py index 11d8b3f21..f85dfacab 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llms_data.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_measure_target.py @@ -31,13 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.llm_model import LlmModel - from gooddata_api_client.model.resolved_llm_provider import ResolvedLlmProvider - globals()['LlmModel'] = LlmModel - globals()['ResolvedLlmProvider'] = ResolvedLlmProvider + from gooddata_api_client.model.conditional_formatting_measure_target_all_of import ConditionalFormattingMeasureTargetAllOf + globals()['ConditionalFormattingMeasureTargetAllOf'] = ConditionalFormattingMeasureTargetAllOf -class ResolvedLlmsData(ModelComposed): +class ConditionalFormattingMeasureTarget(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -62,13 +60,12 @@ class ResolvedLlmsData(ModelComposed): """ allowed_values = { + ('kind',): { + 'MEASURE': "measure", + }, } validations = { - ('models',): { - 'max_items': 1, - 'min_items': 1, - }, } @cached_property @@ -94,9 +91,8 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'models': ([LlmModel],), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'measure_identifier': (str,), # noqa: E501 } @cached_property @@ -105,9 +101,8 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'models': 'models', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'measure_identifier': 'measureIdentifier', # noqa: E501 } read_only_vars = { @@ -116,9 +111,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResolvedLlmsData - a model defined in OpenAPI + """ConditionalFormattingMeasureTarget - a model defined in OpenAPI Keyword Args: + kind (str): The target kind.. defaults to "measure", must be one of ["measure", ] # noqa: E501 + measure_identifier (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -149,11 +146,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - id (str): Provider Id. [optional] # noqa: E501 - title (str): Provider Title. [optional] # noqa: E501 - models ([LlmModel]): [optional] # noqa: E501 """ + kind = kwargs.get('kind', "measure") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -222,9 +217,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ResolvedLlmsData - a model defined in OpenAPI + """ConditionalFormattingMeasureTarget - a model defined in OpenAPI Keyword Args: + kind (str): The target kind.. defaults to "measure", must be one of ["measure", ] # noqa: E501 + measure_identifier (str): _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -255,11 +252,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - id (str): Provider Id. [optional] # noqa: E501 - title (str): Provider Title. [optional] # noqa: E501 - models ([LlmModel]): [optional] # noqa: E501 """ + kind = kwargs.get('kind', "measure") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -327,8 +322,8 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ + ConditionalFormattingMeasureTargetAllOf, ], 'oneOf': [ - ResolvedLlmProvider, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_measure_target_all_of.py similarity index 92% rename from gooddata-api-client/gooddata_api_client/model/date_absolute_filter_all_of.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_measure_target_all_of.py index bb6d2bfab..cc8386998 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_measure_target_all_of.py @@ -31,7 +31,7 @@ -class DateAbsoluteFilterAllOf(ModelNormal): +class ConditionalFormattingMeasureTargetAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,6 +56,9 @@ class DateAbsoluteFilterAllOf(ModelNormal): """ allowed_values = { + ('kind',): { + 'MEASURE': "measure", + }, } validations = { @@ -82,9 +85,8 @@ def openapi_types(): and the value is attribute type. """ return { - '_from': (str,), # noqa: E501 - 'to': (str,), # noqa: E501 - 'using': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'measure_identifier': (str,), # noqa: E501 } @cached_property @@ -93,9 +95,8 @@ def discriminator(): attribute_map = { - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'measure_identifier': 'measureIdentifier', # noqa: E501 } read_only_vars = { @@ -106,7 +107,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingMeasureTargetAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -139,9 +140,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - _from (str): [optional] # noqa: E501 - to (str): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + kind (str): The target kind.. [optional] if omitted the server will use the default value of "measure" # noqa: E501 + measure_identifier (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -194,7 +194,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingMeasureTargetAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -227,9 +227,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - _from (str): [optional] # noqa: E501 - to (str): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + kind (str): The target kind.. [optional] if omitted the server will use the default value of "measure" # noqa: E501 + measure_identifier (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_none_value.py similarity index 93% rename from gooddata-api-client/gooddata_api_client/model/date_absolute_filter.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_none_value.py index 68958cfae..5b8515a5f 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_absolute_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_none_value.py @@ -31,13 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.date_absolute_filter_all_of import DateAbsoluteFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['DateAbsoluteFilterAllOf'] = DateAbsoluteFilterAllOf - globals()['Filter'] = Filter + from gooddata_api_client.model.conditional_formatting_none_value_all_of import ConditionalFormattingNoneValueAllOf + globals()['ConditionalFormattingNoneValueAllOf'] = ConditionalFormattingNoneValueAllOf -class DateAbsoluteFilter(ModelComposed): +class ConditionalFormattingNoneValue(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -62,6 +60,9 @@ class DateAbsoluteFilter(ModelComposed): """ allowed_values = { + ('kind',): { + 'NONE': "none", + }, } validations = { @@ -90,9 +91,7 @@ def openapi_types(): """ lazy_import() return { - '_from': (str,), # noqa: E501 - 'to': (str,), # noqa: E501 - 'using': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 } @cached_property @@ -101,9 +100,7 @@ def discriminator(): attribute_map = { - '_from': 'from', # noqa: E501 - 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 + 'kind': 'kind', # noqa: E501 } read_only_vars = { @@ -112,12 +109,10 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilter - a model defined in OpenAPI + """ConditionalFormattingNoneValue - a model defined in OpenAPI Keyword Args: - _from (str): - to (str): - using (str): + kind (str): The value kind.. defaults to "none", must be one of ["none", ] # 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. @@ -150,6 +145,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + kind = kwargs.get('kind', "none") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -218,12 +214,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """DateAbsoluteFilter - a model defined in OpenAPI + """ConditionalFormattingNoneValue - a model defined in OpenAPI Keyword Args: - _from (str): - to (str): - using (str): + kind (str): The value kind.. defaults to "none", must be one of ["none", ] # 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. @@ -256,6 +250,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + kind = kwargs.get('kind', "none") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -323,8 +318,7 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ - DateAbsoluteFilterAllOf, - Filter, + ConditionalFormattingNoneValueAllOf, ], 'oneOf': [ ], diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_none_value_all_of.py similarity index 94% rename from gooddata-api-client/gooddata_api_client/model/attribute_positive_filter_all_of.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_none_value_all_of.py index 40a51c1f0..0ebb666b4 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_none_value_all_of.py @@ -31,7 +31,7 @@ -class AttributePositiveFilterAllOf(ModelNormal): +class ConditionalFormattingNoneValueAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,6 +56,9 @@ class AttributePositiveFilterAllOf(ModelNormal): """ allowed_values = { + ('kind',): { + 'NONE': "none", + }, } validations = { @@ -82,8 +85,7 @@ def openapi_types(): and the value is attribute type. """ return { - 'include': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 } @cached_property @@ -92,8 +94,7 @@ def discriminator(): attribute_map = { - 'include': 'include', # noqa: E501 - 'using': 'using', # noqa: E501 + 'kind': 'kind', # noqa: E501 } read_only_vars = { @@ -104,7 +105,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributePositiveFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingNoneValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -137,8 +138,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - include ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "none" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -191,7 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """AttributePositiveFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingNoneValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -224,8 +224,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - include ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "none" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_relative_date_value.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/date_relative_filter.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_relative_date_value.py index d37411d91..3939d56c2 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_relative_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_relative_date_value.py @@ -31,13 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.date_relative_filter_all_of import DateRelativeFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['DateRelativeFilterAllOf'] = DateRelativeFilterAllOf - globals()['Filter'] = Filter + from gooddata_api_client.model.conditional_formatting_relative_date_value_all_of import ConditionalFormattingRelativeDateValueAllOf + globals()['ConditionalFormattingRelativeDateValueAllOf'] = ConditionalFormattingRelativeDateValueAllOf -class DateRelativeFilter(ModelComposed): +class ConditionalFormattingRelativeDateValue(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -104,6 +102,9 @@ class DateRelativeFilter(ModelComposed): 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, + ('kind',): { + 'RELATIVEDATE': "relativeDate", + }, } validations = { @@ -134,8 +135,8 @@ def openapi_types(): return { '_from': (int,), # noqa: E501 'granularity': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 'to': (int,), # noqa: E501 - 'using': (str,), # noqa: E501 } @cached_property @@ -146,8 +147,8 @@ def discriminator(): attribute_map = { '_from': 'from', # noqa: E501 'granularity': 'granularity', # noqa: E501 + 'kind': 'kind', # noqa: E501 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 } read_only_vars = { @@ -156,13 +157,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateRelativeFilter - a model defined in OpenAPI + """ConditionalFormattingRelativeDateValue - a model defined in OpenAPI Keyword Args: - _from (int): - granularity (str): - to (int): - using (str): + _from (int): Offset in periods; 0 is the current period, negative is the past. + granularity (str): Granularity the offsets are counted in. + kind (str): The value kind.. defaults to "relativeDate", must be one of ["relativeDate", ] # noqa: E501 + to (int): Offset in periods, not lower than `from`. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -195,6 +196,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + kind = kwargs.get('kind', "relativeDate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -263,13 +265,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """DateRelativeFilter - a model defined in OpenAPI + """ConditionalFormattingRelativeDateValue - a model defined in OpenAPI Keyword Args: - _from (int): - granularity (str): - to (int): - using (str): + _from (int): Offset in periods; 0 is the current period, negative is the past. + granularity (str): Granularity the offsets are counted in. + kind (str): The value kind.. defaults to "relativeDate", must be one of ["relativeDate", ] # noqa: E501 + to (int): Offset in periods, not lower than `from`. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -302,6 +304,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + kind = kwargs.get('kind', "relativeDate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -369,8 +372,7 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ - DateRelativeFilterAllOf, - Filter, + ConditionalFormattingRelativeDateValueAllOf, ], 'oneOf': [ ], diff --git a/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_relative_date_value_all_of.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_relative_date_value_all_of.py index 947e4d48e..61fe82a75 100644 --- a/gooddata-api-client/gooddata_api_client/model/date_relative_filter_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_relative_date_value_all_of.py @@ -31,7 +31,7 @@ -class DateRelativeFilterAllOf(ModelNormal): +class ConditionalFormattingRelativeDateValueAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -98,6 +98,9 @@ class DateRelativeFilterAllOf(ModelNormal): 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, + ('kind',): { + 'RELATIVEDATE': "relativeDate", + }, } validations = { @@ -126,8 +129,8 @@ def openapi_types(): return { '_from': (int,), # noqa: E501 'granularity': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 'to': (int,), # noqa: E501 - 'using': (str,), # noqa: E501 } @cached_property @@ -138,8 +141,8 @@ def discriminator(): attribute_map = { '_from': 'from', # noqa: E501 'granularity': 'granularity', # noqa: E501 + 'kind': 'kind', # noqa: E501 'to': 'to', # noqa: E501 - 'using': 'using', # noqa: E501 } read_only_vars = { @@ -150,7 +153,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DateRelativeFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingRelativeDateValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -183,10 +186,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + _from (int): Offset in periods; 0 is the current period, negative is the past.. [optional] # noqa: E501 + granularity (str): Granularity the offsets are counted in.. [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "relativeDate" # noqa: E501 + to (int): Offset in periods, not lower than `from`.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -239,7 +242,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """DateRelativeFilterAllOf - a model defined in OpenAPI + """ConditionalFormattingRelativeDateValueAllOf - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -272,10 +275,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - _from (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 + _from (int): Offset in periods; 0 is the current period, negative is the past.. [optional] # noqa: E501 + granularity (str): Granularity the offsets are counted in.. [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "relativeDate" # noqa: E501 + to (int): Offset in periods, not lower than `from`.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/conditional_formatting_rule.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_rule.py new file mode 100644 index 000000000..a6bc0b727 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_rule.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.conditional_formatting_condition import ConditionalFormattingCondition + from gooddata_api_client.model.conditional_formatting_target import ConditionalFormattingTarget + globals()['ConditionalFormattingCondition'] = ConditionalFormattingCondition + globals()['ConditionalFormattingTarget'] = ConditionalFormattingTarget + + +class ConditionalFormattingRule(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 { + 'conditions': ([ConditionalFormattingCondition],), # noqa: E501 + 'target': (ConditionalFormattingTarget,), # noqa: E501 + 'id': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'conditions': 'conditions', # noqa: E501 + 'target': 'target', # noqa: E501 + 'id': 'id', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, conditions, target, *args, **kwargs): # noqa: E501 + """ConditionalFormattingRule - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + target (ConditionalFormattingTarget): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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): Client-assigned identifier, stable across edits.. [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.conditions = conditions + self.target = target + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, conditions, target, *args, **kwargs): # noqa: E501 + """ConditionalFormattingRule - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + target (ConditionalFormattingTarget): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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): Client-assigned identifier, stable across edits.. [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.conditions = conditions + self.target = target + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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/conditional_formatting_target.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_target.py new file mode 100644 index 000000000..815923b91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_target.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.conditional_formatting_attribute_target import ConditionalFormattingAttributeTarget + from gooddata_api_client.model.conditional_formatting_measure_target import ConditionalFormattingMeasureTarget + globals()['ConditionalFormattingAttributeTarget'] = ConditionalFormattingAttributeTarget + globals()['ConditionalFormattingMeasureTarget'] = ConditionalFormattingMeasureTarget + + +class ConditionalFormattingTarget(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 = { + ('kind',): { + 'MEASURE': "measure", + }, + } + + 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_identifier': (str,), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'measure_identifier': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'attribute_identifier': 'attributeIdentifier', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'measure_identifier': 'measureIdentifier', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ConditionalFormattingTarget - 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_identifier (str): [optional] # noqa: E501 + kind (str): The target kind.. [optional] if omitted the server will use the default value of "measure" # noqa: E501 + measure_identifier (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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 + """ConditionalFormattingTarget - 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_identifier (str): [optional] # noqa: E501 + kind (str): The target kind.. [optional] if omitted the server will use the default value of "measure" # noqa: E501 + measure_identifier (str): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + 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': [ + ConditionalFormattingAttributeTarget, + ConditionalFormattingMeasureTarget, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_value.py similarity index 84% rename from gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py rename to gooddata-api-client/gooddata_api_client/model/conditional_formatting_value.py index 3fddd8d92..d7d585381 100644 --- a/gooddata-api-client/gooddata_api_client/model/created_visualization_filters_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/conditional_formatting_value.py @@ -31,19 +31,21 @@ def lazy_import(): - from gooddata_api_client.model.attribute_negative_filter import AttributeNegativeFilter - from gooddata_api_client.model.attribute_positive_filter import AttributePositiveFilter - from gooddata_api_client.model.date_absolute_filter import DateAbsoluteFilter - from gooddata_api_client.model.date_relative_filter import DateRelativeFilter - from gooddata_api_client.model.gen_ai_ranking_filter import GenAiRankingFilter - globals()['AttributeNegativeFilter'] = AttributeNegativeFilter - globals()['AttributePositiveFilter'] = AttributePositiveFilter - globals()['DateAbsoluteFilter'] = DateAbsoluteFilter - globals()['DateRelativeFilter'] = DateRelativeFilter - globals()['GenAiRankingFilter'] = GenAiRankingFilter - - -class CreatedVisualizationFiltersInner(ModelComposed): + from gooddata_api_client.model.conditional_formatting_absolute_date_value import ConditionalFormattingAbsoluteDateValue + from gooddata_api_client.model.conditional_formatting_literal import ConditionalFormattingLiteral + from gooddata_api_client.model.conditional_formatting_literal_range_value import ConditionalFormattingLiteralRangeValue + from gooddata_api_client.model.conditional_formatting_literal_value import ConditionalFormattingLiteralValue + from gooddata_api_client.model.conditional_formatting_none_value import ConditionalFormattingNoneValue + from gooddata_api_client.model.conditional_formatting_relative_date_value import ConditionalFormattingRelativeDateValue + globals()['ConditionalFormattingAbsoluteDateValue'] = ConditionalFormattingAbsoluteDateValue + globals()['ConditionalFormattingLiteral'] = ConditionalFormattingLiteral + globals()['ConditionalFormattingLiteralRangeValue'] = ConditionalFormattingLiteralRangeValue + globals()['ConditionalFormattingLiteralValue'] = ConditionalFormattingLiteralValue + globals()['ConditionalFormattingNoneValue'] = ConditionalFormattingNoneValue + globals()['ConditionalFormattingRelativeDateValue'] = ConditionalFormattingRelativeDateValue + + +class ConditionalFormattingValue(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -68,6 +70,9 @@ class CreatedVisualizationFiltersInner(ModelComposed): """ allowed_values = { + ('kind',): { + 'RELATIVEDATE': "relativeDate", + }, ('granularity',): { 'SECOND': "SECOND", 'SECOND_OF_MINUTE': "SECOND_OF_MINUTE", @@ -110,10 +115,6 @@ class CreatedVisualizationFiltersInner(ModelComposed): 'FISCAL_SEMESTER_OF_FISCAL_YEAR': "FISCAL_SEMESTER_OF_FISCAL_YEAR", 'FISCAL_YEAR': "FISCAL_YEAR", }, - ('operator',): { - 'TOP': "TOP", - 'BOTTOM': "BOTTOM", - }, } validations = { @@ -142,16 +143,11 @@ def openapi_types(): """ lazy_import() return { - 'dimensionality': ([str],), # noqa: E501 - 'exclude': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 - 'include': ([str],), # noqa: E501 + 'kind': (str,), # noqa: E501 + 'value': (ConditionalFormattingLiteral,), # noqa: E501 '_from': (int,), # noqa: E501 'to': (int,), # noqa: E501 'granularity': (str,), # noqa: E501 - 'measures': ([str],), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'value': (int,), # noqa: E501 } @cached_property @@ -160,16 +156,11 @@ def discriminator(): attribute_map = { - 'dimensionality': 'dimensionality', # noqa: E501 - 'exclude': 'exclude', # noqa: E501 - 'using': 'using', # noqa: E501 - 'include': 'include', # noqa: E501 + 'kind': 'kind', # noqa: E501 + 'value': 'value', # noqa: E501 '_from': 'from', # noqa: E501 'to': 'to', # noqa: E501 'granularity': 'granularity', # noqa: E501 - 'measures': 'measures', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'value': 'value', # noqa: E501 } read_only_vars = { @@ -178,7 +169,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CreatedVisualizationFiltersInner - a model defined in OpenAPI + """ConditionalFormattingValue - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -211,16 +202,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dimensionality ([str]): [optional] # noqa: E501 - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - include ([str]): [optional] # noqa: E501 - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - measures ([str]): [optional] # noqa: E501 - operator (str): [optional] # noqa: E501 - value (int): [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "relativeDate" # noqa: E501 + value (ConditionalFormattingLiteral): [optional] # noqa: E501 + _from (int): Offset in periods; 0 is the current period, negative is the past.. [optional] # noqa: E501 + to (int): Offset in periods, not lower than `from`.. [optional] # noqa: E501 + granularity (str): Granularity the offsets are counted in.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -291,7 +277,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """CreatedVisualizationFiltersInner - a model defined in OpenAPI + """ConditionalFormattingValue - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -324,16 +310,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dimensionality ([str]): [optional] # noqa: E501 - exclude ([str]): [optional] # noqa: E501 - using (str): [optional] # noqa: E501 - include ([str]): [optional] # noqa: E501 - _from (int): [optional] # noqa: E501 - to (int): [optional] # noqa: E501 - granularity (str): [optional] # noqa: E501 - measures ([str]): [optional] # noqa: E501 - operator (str): [optional] # noqa: E501 - value (int): [optional] # noqa: E501 + kind (str): The value kind.. [optional] if omitted the server will use the default value of "relativeDate" # noqa: E501 + value (ConditionalFormattingLiteral): [optional] # noqa: E501 + _from (int): Offset in periods; 0 is the current period, negative is the past.. [optional] # noqa: E501 + to (int): Offset in periods, not lower than `from`.. [optional] # noqa: E501 + granularity (str): Granularity the offsets are counted in.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -405,10 +386,10 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ - AttributeNegativeFilter, - AttributePositiveFilter, - DateAbsoluteFilter, - DateRelativeFilter, - GenAiRankingFilter, + ConditionalFormattingAbsoluteDateValue, + ConditionalFormattingLiteralRangeValue, + ConditionalFormattingLiteralValue, + ConditionalFormattingNoneValue, + ConditionalFormattingRelativeDateValue, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py b/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py deleted file mode 100644 index c68e9daa6..000000000 --- a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request.py +++ /dev/null @@ -1,330 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_expression import ColumnExpression - from gooddata_api_client.model.create_pipe_table_request_distribution_config import CreatePipeTableRequestDistributionConfig - from gooddata_api_client.model.create_pipe_table_request_key_config import CreatePipeTableRequestKeyConfig - from gooddata_api_client.model.create_pipe_table_request_partition_config import CreatePipeTableRequestPartitionConfig - globals()['ColumnExpression'] = ColumnExpression - globals()['CreatePipeTableRequestDistributionConfig'] = CreatePipeTableRequestDistributionConfig - globals()['CreatePipeTableRequestKeyConfig'] = CreatePipeTableRequestKeyConfig - globals()['CreatePipeTableRequestPartitionConfig'] = CreatePipeTableRequestPartitionConfig - - -class CreatePipeTableRequest(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 { - 'path_prefix': (str,), # noqa: E501 - 'source_storage_name': (str,), # noqa: E501 - 'table_name': (str,), # noqa: E501 - 'aggregation_overrides': ({str: (str,)},), # noqa: E501 - 'column_expressions': ({str: (ColumnExpression,)},), # noqa: E501 - 'column_overrides': ({str: (str,)},), # noqa: E501 - 'distribution_config': (CreatePipeTableRequestDistributionConfig,), # noqa: E501 - 'key_config': (CreatePipeTableRequestKeyConfig,), # noqa: E501 - 'max_varchar_length': (int,), # noqa: E501 - 'partition_config': (CreatePipeTableRequestPartitionConfig,), # noqa: E501 - 'polling_interval_seconds': (int,), # noqa: E501 - 'table_properties': ({str: (str,)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'path_prefix': 'pathPrefix', # noqa: E501 - 'source_storage_name': 'sourceStorageName', # noqa: E501 - 'table_name': 'tableName', # noqa: E501 - 'aggregation_overrides': 'aggregationOverrides', # noqa: E501 - 'column_expressions': 'columnExpressions', # noqa: E501 - 'column_overrides': 'columnOverrides', # noqa: E501 - 'distribution_config': 'distributionConfig', # noqa: E501 - 'key_config': 'keyConfig', # noqa: E501 - 'max_varchar_length': 'maxVarcharLength', # noqa: E501 - 'partition_config': 'partitionConfig', # noqa: E501 - 'polling_interval_seconds': 'pollingIntervalSeconds', # noqa: E501 - 'table_properties': 'tableProperties', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, path_prefix, source_storage_name, table_name, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequest - a model defined in OpenAPI - - Args: - path_prefix (str): Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported. - source_storage_name (str): Name of the pre-configured S3/MinIO ObjectStorage source - table_name (str): Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$ - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregation_overrides ({str: (str,)}): Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.. [optional] # noqa: E501 - column_expressions ({str: (ColumnExpression,)}): Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).. [optional] # noqa: E501 - column_overrides ({str: (str,)}): Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.. [optional] # noqa: E501 - distribution_config (CreatePipeTableRequestDistributionConfig): [optional] # noqa: E501 - key_config (CreatePipeTableRequestKeyConfig): [optional] # noqa: E501 - max_varchar_length (int): Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.. [optional] # noqa: E501 - partition_config (CreatePipeTableRequestPartitionConfig): [optional] # noqa: E501 - polling_interval_seconds (int): How often (in seconds) the pipe polls for new files. 0 or null = use server default.. [optional] # noqa: E501 - table_properties ({str: (str,)}): CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.path_prefix = path_prefix - self.source_storage_name = source_storage_name - self.table_name = table_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, path_prefix, source_storage_name, table_name, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequest - a model defined in OpenAPI - - Args: - path_prefix (str): Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported. - source_storage_name (str): Name of the pre-configured S3/MinIO ObjectStorage source - table_name (str): Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$ - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - aggregation_overrides ({str: (str,)}): Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.. [optional] # noqa: E501 - column_expressions ({str: (ColumnExpression,)}): Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).. [optional] # noqa: E501 - column_overrides ({str: (str,)}): Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.. [optional] # noqa: E501 - distribution_config (CreatePipeTableRequestDistributionConfig): [optional] # noqa: E501 - key_config (CreatePipeTableRequestKeyConfig): [optional] # noqa: E501 - max_varchar_length (int): Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.. [optional] # noqa: E501 - partition_config (CreatePipeTableRequestPartitionConfig): [optional] # noqa: E501 - polling_interval_seconds (int): How often (in seconds) the pipe polls for new files. 0 or null = use server default.. [optional] # noqa: E501 - table_properties ({str: (str,)}): CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.. [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.path_prefix = path_prefix - self.source_storage_name = source_storage_name - self.table_name = table_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/date_trunc_partition_config.py b/gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py deleted file mode 100644 index 0b64a88d2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/date_trunc_partition_config.py +++ /dev/null @@ -1,299 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DateTruncPartitionConfig(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',): { - 'DATETRUNC': "dateTrunc", - }, - ('unit',): { - 'YEAR': "year", - 'QUARTER': "quarter", - 'MONTH': "month", - 'WEEK': "week", - 'DAY': "day", - 'HOUR': "hour", - 'MINUTE': "minute", - 'SECOND': "second", - 'MILLISECOND': "millisecond", - 'MICROSECOND': "microsecond", - }, - } - - 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 { - 'column': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'unit': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column': 'column', # noqa: E501 - 'type': 'type', # noqa: E501 - 'unit': 'unit', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column, unit, *args, **kwargs): # noqa: E501 - """DateTruncPartitionConfig - a model defined in OpenAPI - - Args: - column (str): Column to partition on. - unit (str): Date/time unit for partition granularity - - Keyword Args: - type (str): defaults to "dateTrunc", must be one of ["dateTrunc", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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', "dateTrunc") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.type = type - self.unit = unit - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, column, unit, *args, **kwargs): # noqa: E501 - """DateTruncPartitionConfig - a model defined in OpenAPI - - Args: - column (str): Column to partition on. - unit (str): Date/time unit for partition granularity - - Keyword Args: - type (str): defaults to "dateTrunc", must be one of ["dateTrunc", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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', "dateTrunc") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.type = type - self.unit = unit - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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_agent.py b/gooddata-api-client/gooddata_api_client/model/declarative_agent.py index 6288da3ca..c5116d302 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_agent.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_agent.py @@ -33,8 +33,10 @@ def lazy_import(): from gooddata_api_client.model.declarative_user_group_identifier import DeclarativeUserGroupIdentifier from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier + from gooddata_api_client.model.instruction import Instruction globals()['DeclarativeUserGroupIdentifier'] = DeclarativeUserGroupIdentifier globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier + globals()['Instruction'] = Instruction class DeclarativeAgent(ModelNormal): @@ -75,6 +77,9 @@ class DeclarativeAgent(ModelNormal): 'DASHBOARD_SUMMARY': "dashboard_summary", 'WHAT_IF_ANALYSIS': "what_if_analysis", 'KNOWLEDGE': "knowledge", + 'DASHBOARD_BUILDER': "dashboard_builder", + 'DASHBOARD_EDITOR': "dashboard_editor", + 'REPORT_BUILDER': "report_builder", }, ('skills_mode',): { 'ALL': "all", @@ -127,6 +132,7 @@ def openapi_types(): 'custom_skills': ([str],), # noqa: E501 'description': (str,), # noqa: E501 'enabled': (bool,), # noqa: E501 + 'instructions': ([Instruction], none_type,), # noqa: E501 'modified_at': (str, none_type,), # noqa: E501 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 'name': (str,), # noqa: E501 @@ -149,6 +155,7 @@ def discriminator(): 'custom_skills': 'customSkills', # noqa: E501 'description': 'description', # noqa: E501 'enabled': 'enabled', # noqa: E501 + 'instructions': 'instructions', # noqa: E501 'modified_at': 'modifiedAt', # noqa: E501 'modified_by': 'modifiedBy', # noqa: E501 'name': 'name', # noqa: E501 @@ -208,6 +215,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 custom_skills ([str]): List of custom skills when skillsMode is CUSTOM.. [optional] # noqa: E501 description (str): Description of the agent.. [optional] # noqa: E501 enabled (bool): Whether the agent is enabled.. [optional] # noqa: E501 + instructions ([Instruction], none_type): Rules this agent follows when answering.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 name (str): Name of the agent.. [optional] # noqa: E501 @@ -310,6 +318,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 custom_skills ([str]): List of custom skills when skillsMode is CUSTOM.. [optional] # noqa: E501 description (str): Description of the agent.. [optional] # noqa: E501 enabled (bool): Whether the agent is enabled.. [optional] # noqa: E501 + instructions ([Instruction], none_type): Rules this agent follows when answering.. [optional] # noqa: E501 modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 name (str): Name of the agent.. [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 64a573a3e..64b6317c5 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 @@ -34,22 +34,30 @@ def lazy_import(): from gooddata_api_client.model.declarative_analytical_dashboard import DeclarativeAnalyticalDashboard from gooddata_api_client.model.declarative_analytical_dashboard_extension import DeclarativeAnalyticalDashboardExtension from gooddata_api_client.model.declarative_attribute_hierarchy import DeclarativeAttributeHierarchy + from gooddata_api_client.model.declarative_computed_attribute import DeclarativeComputedAttribute from gooddata_api_client.model.declarative_dashboard_plugin import DeclarativeDashboardPlugin from gooddata_api_client.model.declarative_export_definition import DeclarativeExportDefinition from gooddata_api_client.model.declarative_filter_context import DeclarativeFilterContext from gooddata_api_client.model.declarative_memory_item import DeclarativeMemoryItem from gooddata_api_client.model.declarative_metric import DeclarativeMetric from gooddata_api_client.model.declarative_parameter import DeclarativeParameter + 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 from gooddata_api_client.model.declarative_visualization_object import DeclarativeVisualizationObject globals()['DeclarativeAnalyticalDashboard'] = DeclarativeAnalyticalDashboard globals()['DeclarativeAnalyticalDashboardExtension'] = DeclarativeAnalyticalDashboardExtension globals()['DeclarativeAttributeHierarchy'] = DeclarativeAttributeHierarchy + globals()['DeclarativeComputedAttribute'] = DeclarativeComputedAttribute globals()['DeclarativeDashboardPlugin'] = DeclarativeDashboardPlugin globals()['DeclarativeExportDefinition'] = DeclarativeExportDefinition globals()['DeclarativeFilterContext'] = DeclarativeFilterContext globals()['DeclarativeMemoryItem'] = DeclarativeMemoryItem globals()['DeclarativeMetric'] = DeclarativeMetric globals()['DeclarativeParameter'] = DeclarativeParameter + globals()['DeclarativeReport'] = DeclarativeReport + globals()['DeclarativeReportPageLayout'] = DeclarativeReportPageLayout + globals()['DeclarativeReportTemplate'] = DeclarativeReportTemplate globals()['DeclarativeVisualizationObject'] = DeclarativeVisualizationObject @@ -109,12 +117,16 @@ def openapi_types(): 'analytical_dashboard_extensions': ([DeclarativeAnalyticalDashboardExtension],), # noqa: E501 'analytical_dashboards': ([DeclarativeAnalyticalDashboard],), # noqa: E501 'attribute_hierarchies': ([DeclarativeAttributeHierarchy],), # noqa: E501 + 'computed_attributes': ([DeclarativeComputedAttribute],), # noqa: E501 'dashboard_plugins': ([DeclarativeDashboardPlugin],), # noqa: E501 'export_definitions': ([DeclarativeExportDefinition],), # noqa: E501 'filter_contexts': ([DeclarativeFilterContext],), # noqa: E501 'memory_items': ([DeclarativeMemoryItem],), # noqa: E501 'metrics': ([DeclarativeMetric],), # noqa: E501 'parameters': ([DeclarativeParameter],), # noqa: E501 + 'report_page_layouts': ([DeclarativeReportPageLayout],), # noqa: E501 + 'report_templates': ([DeclarativeReportTemplate],), # noqa: E501 + 'reports': ([DeclarativeReport],), # noqa: E501 'visualization_objects': ([DeclarativeVisualizationObject],), # noqa: E501 } @@ -127,12 +139,16 @@ def discriminator(): 'analytical_dashboard_extensions': 'analyticalDashboardExtensions', # noqa: E501 'analytical_dashboards': 'analyticalDashboards', # noqa: E501 'attribute_hierarchies': 'attributeHierarchies', # noqa: E501 + 'computed_attributes': 'computedAttributes', # noqa: E501 'dashboard_plugins': 'dashboardPlugins', # noqa: E501 'export_definitions': 'exportDefinitions', # noqa: E501 'filter_contexts': 'filterContexts', # noqa: E501 'memory_items': 'memoryItems', # noqa: E501 'metrics': 'metrics', # noqa: E501 'parameters': 'parameters', # noqa: E501 + 'report_page_layouts': 'reportPageLayouts', # noqa: E501 + 'report_templates': 'reportTemplates', # noqa: E501 + 'reports': 'reports', # noqa: E501 'visualization_objects': 'visualizationObjects', # noqa: E501 } @@ -180,12 +196,16 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 analytical_dashboard_extensions ([DeclarativeAnalyticalDashboardExtension]): A list of dashboard permissions assigned to a related dashboard.. [optional] # noqa: E501 analytical_dashboards ([DeclarativeAnalyticalDashboard]): A list of analytical dashboards available in the model.. [optional] # 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 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 parameters ([DeclarativeParameter]): A list of parameters available in the model.. [optional] # noqa: E501 + report_page_layouts ([DeclarativeReportPageLayout]): A list of report page layouts available in the model.. [optional] # noqa: E501 + report_templates ([DeclarativeReportTemplate]): A list of report templates available in the model.. [optional] # noqa: E501 + reports ([DeclarativeReport]): A list of reports available in the model.. [optional] # noqa: E501 visualization_objects ([DeclarativeVisualizationObject]): A list of visualization objects available in the model.. [optional] # noqa: E501 """ @@ -275,12 +295,16 @@ def __init__(self, *args, **kwargs): # noqa: E501 analytical_dashboard_extensions ([DeclarativeAnalyticalDashboardExtension]): A list of dashboard permissions assigned to a related dashboard.. [optional] # noqa: E501 analytical_dashboards ([DeclarativeAnalyticalDashboard]): A list of analytical dashboards available in the model.. [optional] # 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 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 parameters ([DeclarativeParameter]): A list of parameters available in the model.. [optional] # noqa: E501 + report_page_layouts ([DeclarativeReportPageLayout]): A list of report page layouts available in the model.. [optional] # noqa: E501 + report_templates ([DeclarativeReportTemplate]): A list of report templates available in the model.. [optional] # noqa: E501 + reports ([DeclarativeReport]): A list of reports available in the model.. [optional] # noqa: E501 visualization_objects ([DeclarativeVisualizationObject]): A list of visualization objects available in the model.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py b/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py index fefad4164..c20860aad 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_attribute.py @@ -33,8 +33,10 @@ def lazy_import(): from gooddata_api_client.model.declarative_label import DeclarativeLabel from gooddata_api_client.model.label_identifier import LabelIdentifier + from gooddata_api_client.model.object_conditional_formatting import ObjectConditionalFormatting globals()['DeclarativeLabel'] = DeclarativeLabel globals()['LabelIdentifier'] = LabelIdentifier + globals()['ObjectConditionalFormatting'] = ObjectConditionalFormatting class DeclarativeAttribute(ModelNormal): @@ -129,6 +131,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'labels': ([DeclarativeLabel],), # noqa: E501 'title': (str,), # noqa: E501 + 'conditional_formatting': (ObjectConditionalFormatting,), # noqa: E501 'default_view': (LabelIdentifier,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -151,6 +154,7 @@ def discriminator(): 'id': 'id', # noqa: E501 'labels': 'labels', # noqa: E501 'title': 'title', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'default_view': 'defaultView', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -210,6 +214,7 @@ def _from_openapi_data(cls, id, labels, title, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 default_view (LabelIdentifier): [optional] # noqa: E501 description (str): Attribute description.. [optional] # noqa: E501 is_hidden (bool): If true, this attribute is hidden from AI search results.. [optional] # noqa: E501 @@ -314,6 +319,7 @@ def __init__(self, id, labels, title, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 default_view (LabelIdentifier): [optional] # noqa: E501 description (str): Attribute description.. [optional] # noqa: E501 is_hidden (bool): If true, this attribute is hidden from AI search results.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualization.py b/gooddata-api-client/gooddata_api_client/model/declarative_computed_attribute.py similarity index 59% rename from gooddata-api-client/gooddata_api_client/model/created_visualization.py rename to gooddata-api-client/gooddata_api_client/model/declarative_computed_attribute.py index 37cb0b068..00851915e 100644 --- a/gooddata-api-client/gooddata_api_client/model/created_visualization.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_computed_attribute.py @@ -31,19 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.created_visualization_filters_inner import CreatedVisualizationFiltersInner - from gooddata_api_client.model.dim_attribute import DimAttribute - from gooddata_api_client.model.metric import Metric - from gooddata_api_client.model.suggestion import Suggestion - from gooddata_api_client.model.visualization_config import VisualizationConfig - globals()['CreatedVisualizationFiltersInner'] = CreatedVisualizationFiltersInner - globals()['DimAttribute'] = DimAttribute - globals()['Metric'] = Metric - globals()['Suggestion'] = Suggestion - globals()['VisualizationConfig'] = VisualizationConfig - - -class CreatedVisualization(ModelNormal): + from gooddata_api_client.model.declarative_computed_attribute_content import DeclarativeComputedAttributeContent + from gooddata_api_client.model.declarative_user_identifier import DeclarativeUserIdentifier + globals()['DeclarativeComputedAttributeContent'] = DeclarativeComputedAttributeContent + globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier + + +class DeclarativeComputedAttribute(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -68,18 +62,64 @@ class CreatedVisualization(ModelNormal): """ allowed_values = { - ('visualization_type',): { - 'TABLE': "TABLE", - 'HEADLINE': "HEADLINE", - 'BAR': "BAR", - 'LINE': "LINE", - 'PIE': "PIE", - 'COLUMN': "COLUMN", - 'SCATTER': "SCATTER", + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, + ('data_type',): { + 'INT': "INT", + 'STRING': "STRING", + 'DATE': "DATE", + 'NUMERIC': "NUMERIC", + 'TIMESTAMP': "TIMESTAMP", + 'TIMESTAMP_TZ': "TIMESTAMP_TZ", + 'BOOLEAN': "BOOLEAN", + 'HLL': "HLL", + }, + ('value_type',): { + 'TEXT': "TEXT", + 'HYPERLINK': "HYPERLINK", + 'GEO': "GEO", + 'GEO_LONGITUDE': "GEO_LONGITUDE", + 'GEO_LATITUDE': "GEO_LATITUDE", + 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", + 'IMAGE': "IMAGE", + 'HYPERLOGLOG': "HYPERLOGLOG", }, } validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, + }, + ('certified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('data_type',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('tags',): { + }, } @cached_property @@ -105,15 +145,25 @@ def openapi_types(): """ lazy_import() return { - 'dimensionality': ([DimAttribute],), # noqa: E501 - 'filters': ([CreatedVisualizationFiltersInner],), # noqa: E501 + 'content': (DeclarativeComputedAttributeContent,), # noqa: E501 'id': (str,), # noqa: E501 - 'metrics': ([Metric],), # noqa: E501 - 'suggestions': ([Suggestion],), # noqa: E501 'title': (str,), # noqa: E501 - 'visualization_type': (str,), # noqa: E501 - 'config': (VisualizationConfig,), # noqa: E501 - 'saved_visualization_id': (str,), # noqa: E501 + 'certification': (str,), # noqa: E501 + 'certification_message': (str, none_type,), # noqa: E501 + 'certified_at': (str, none_type,), # noqa: E501 + 'certified_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'created_at': (str, none_type,), # noqa: E501 + 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'data_type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'is_hidden': (bool,), # noqa: E501 + 'is_nullable': (bool,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'modified_at': (str, none_type,), # noqa: E501 + 'modified_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'null_value': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'value_type': (str,), # noqa: E501 } @cached_property @@ -122,15 +172,25 @@ def discriminator(): attribute_map = { - 'dimensionality': 'dimensionality', # noqa: E501 - 'filters': 'filters', # noqa: E501 + 'content': 'content', # noqa: E501 'id': 'id', # noqa: E501 - 'metrics': 'metrics', # noqa: E501 - 'suggestions': 'suggestions', # noqa: E501 'title': 'title', # noqa: E501 - 'visualization_type': 'visualizationType', # noqa: E501 - 'config': 'config', # noqa: E501 - 'saved_visualization_id': 'savedVisualizationId', # noqa: E501 + 'certification': 'certification', # noqa: E501 + 'certification_message': 'certificationMessage', # noqa: E501 + 'certified_at': 'certifiedAt', # noqa: E501 + 'certified_by': 'certifiedBy', # noqa: E501 + 'created_at': 'createdAt', # noqa: E501 + 'created_by': 'createdBy', # noqa: E501 + 'data_type': 'dataType', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_hidden': 'isHidden', # noqa: E501 + 'is_nullable': 'isNullable', # noqa: E501 + 'locale': 'locale', # noqa: E501 + 'modified_at': 'modifiedAt', # noqa: E501 + 'modified_by': 'modifiedBy', # noqa: E501 + 'null_value': 'nullValue', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'value_type': 'valueType', # noqa: E501 } read_only_vars = { @@ -140,17 +200,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, dimensionality, filters, id, metrics, suggestions, title, visualization_type, *args, **kwargs): # noqa: E501 - """CreatedVisualization - a model defined in OpenAPI + def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 + """DeclarativeComputedAttribute - a model defined in OpenAPI Args: - dimensionality ([DimAttribute]): List of attributes representing the dimensionality of the new visualization - filters ([CreatedVisualizationFiltersInner]): List of filters to be applied to the new visualization - id (str): Proposed ID of the new visualization - metrics ([Metric]): List of metrics to be used in the new visualization - suggestions ([Suggestion]): Suggestions for next steps - title (str): Proposed title of the new visualization - visualization_type (str): Visualization type requested in question + content (DeclarativeComputedAttributeContent): + id (str): Computed attribute ID. + title (str): Computed attribute title. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -183,8 +239,22 @@ def _from_openapi_data(cls, dimensionality, filters, id, metrics, suggestions, t Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - config (VisualizationConfig): [optional] # noqa: E501 - saved_visualization_id (str): Saved visualization ID.. [optional] # noqa: E501 + certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 + certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 + certified_at (str, none_type): Time when the certification was set.. [optional] # noqa: E501 + certified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 + created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + data_type (str): Computed attribute data type. [optional] # noqa: E501 + description (str): Computed attribute description.. [optional] # noqa: E501 + is_hidden (bool): If true, this computed attribute is hidden from AI search results.. [optional] # noqa: E501 + is_nullable (bool): Flag indicating whether the associated source column allows null values.. [optional] # noqa: E501 + locale (str): Default locale for primary computed label.. [optional] # noqa: E501 + modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 + modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + null_value (str): Value used in coalesce during joins instead of null.. [optional] # noqa: E501 + tags ([str]): A list of tags.. [optional] # noqa: E501 + value_type (str): Specific type of the computed attribute value. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -216,13 +286,9 @@ def _from_openapi_data(cls, dimensionality, filters, id, metrics, suggestions, t self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.dimensionality = dimensionality - self.filters = filters + self.content = content self.id = id - self.metrics = metrics - self.suggestions = suggestions self.title = title - self.visualization_type = visualization_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -243,17 +309,13 @@ def _from_openapi_data(cls, dimensionality, filters, id, metrics, suggestions, t ]) @convert_js_args_to_python_args - def __init__(self, dimensionality, filters, id, metrics, suggestions, title, visualization_type, *args, **kwargs): # noqa: E501 - """CreatedVisualization - a model defined in OpenAPI + def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 + """DeclarativeComputedAttribute - a model defined in OpenAPI Args: - dimensionality ([DimAttribute]): List of attributes representing the dimensionality of the new visualization - filters ([CreatedVisualizationFiltersInner]): List of filters to be applied to the new visualization - id (str): Proposed ID of the new visualization - metrics ([Metric]): List of metrics to be used in the new visualization - suggestions ([Suggestion]): Suggestions for next steps - title (str): Proposed title of the new visualization - visualization_type (str): Visualization type requested in question + content (DeclarativeComputedAttributeContent): + id (str): Computed attribute ID. + title (str): Computed attribute title. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -286,8 +348,22 @@ def __init__(self, dimensionality, filters, id, metrics, suggestions, title, vis Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - config (VisualizationConfig): [optional] # noqa: E501 - saved_visualization_id (str): Saved visualization ID.. [optional] # noqa: E501 + certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 + certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 + certified_at (str, none_type): Time when the certification was set.. [optional] # noqa: E501 + certified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 + created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + data_type (str): Computed attribute data type. [optional] # noqa: E501 + description (str): Computed attribute description.. [optional] # noqa: E501 + is_hidden (bool): If true, this computed attribute is hidden from AI search results.. [optional] # noqa: E501 + is_nullable (bool): Flag indicating whether the associated source column allows null values.. [optional] # noqa: E501 + locale (str): Default locale for primary computed label.. [optional] # noqa: E501 + modified_at (str, none_type): Time of the last entity modification.. [optional] # noqa: E501 + modified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + null_value (str): Value used in coalesce during joins instead of null.. [optional] # noqa: E501 + tags ([str]): A list of tags.. [optional] # noqa: E501 + value_type (str): Specific type of the computed attribute value. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -317,13 +393,9 @@ def __init__(self, dimensionality, filters, id, metrics, suggestions, title, vis self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.dimensionality = dimensionality - self.filters = filters + self.content = content self.id = id - self.metrics = metrics - self.suggestions = suggestions self.title = title - self.visualization_type = visualization_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_content.py b/gooddata-api-client/gooddata_api_client/model/declarative_computed_attribute_content.py similarity index 98% rename from gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_content.py rename to gooddata-api-client/gooddata_api_client/model/declarative_computed_attribute_content.py index 3676cceeb..3b586dbe1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_content.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_computed_attribute_content.py @@ -31,7 +31,7 @@ -class JsonApiMetricInAttributesContent(ModelNormal): +class DeclarativeComputedAttributeContent(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, maql, *args, **kwargs): # noqa: E501 - """JsonApiMetricInAttributesContent - a model defined in OpenAPI + """DeclarativeComputedAttributeContent - a model defined in OpenAPI Args: maql (str): @@ -207,7 +207,7 @@ def _from_openapi_data(cls, maql, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, maql, *args, **kwargs): # noqa: E501 - """JsonApiMetricInAttributesContent - a model defined in OpenAPI + """DeclarativeComputedAttributeContent - a model defined in OpenAPI Args: maql (str): 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 cde461292..049070a32 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 @@ -92,6 +92,7 @@ class DeclarativeDataSource(ModelNormal): 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", + 'TRINO': "TRINO", }, ('authentication_type',): { 'None': None, @@ -190,6 +191,7 @@ def openapi_types(): 'client_secret': (str,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 'decoded_parameters': ([Parameter],), # noqa: E501 + 'disable_statistics': (bool, none_type,), # noqa: E501 'parameters': ([Parameter],), # noqa: E501 'password': (str,), # noqa: E501 'permissions': ([DeclarativeDataSourcePermission],), # noqa: E501 @@ -218,6 +220,7 @@ def discriminator(): 'client_secret': 'clientSecret', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'decoded_parameters': 'decodedParameters', # noqa: E501 + 'disable_statistics': 'disableStatistics', # noqa: E501 'parameters': 'parameters', # noqa: E501 'password': 'password', # noqa: E501 'permissions': 'permissions', # noqa: E501 @@ -283,6 +286,7 @@ def _from_openapi_data(cls, id, name, schema, type, *args, **kwargs): # noqa: E client_secret (str): The client secret to use to connect to the database providing the data for the data source.. [optional] # 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 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 @@ -394,6 +398,7 @@ def __init__(self, id, name, schema, type, *args, **kwargs): # noqa: E501 client_secret (str): The client secret to use to connect to the database providing the data for the data source.. [optional] # noqa: E501 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 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_date_dataset.py b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py index 1d6f0a8cc..43adbd4ac 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_date_dataset.py @@ -32,7 +32,9 @@ def lazy_import(): from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting + from gooddata_api_client.model.object_conditional_formatting import ObjectConditionalFormatting globals()['GranularitiesFormatting'] = GranularitiesFormatting + globals()['ObjectConditionalFormatting'] = ObjectConditionalFormatting class DeclarativeDateDataset(ModelNormal): @@ -147,6 +149,7 @@ def openapi_types(): 'granularities_formatting': (GranularitiesFormatting,), # noqa: E501 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 + 'conditional_formatting': (ObjectConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'tags': ([str],), # noqa: E501 } @@ -161,6 +164,7 @@ def discriminator(): 'granularities_formatting': 'granularitiesFormatting', # noqa: E501 'id': 'id', # noqa: E501 'title': 'title', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'tags': 'tags', # noqa: E501 } @@ -212,6 +216,7 @@ def _from_openapi_data(cls, granularities, granularities_formatting, id, title, Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 description (str): Date dataset description.. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ @@ -309,6 +314,7 @@ def __init__(self, granularities, granularities_formatting, id, title, *args, ** Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 description (str): Date dataset description.. [optional] # noqa: E501 tags ([str]): A list of tags.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_label.py b/gooddata-api-client/gooddata_api_client/model/declarative_label.py index d8ef19d82..6784a647e 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_label.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_label.py @@ -33,8 +33,10 @@ def lazy_import(): from gooddata_api_client.model.declarative_label_translation import DeclarativeLabelTranslation from gooddata_api_client.model.geo_area_config import GeoAreaConfig + from gooddata_api_client.model.object_conditional_formatting import ObjectConditionalFormatting globals()['DeclarativeLabelTranslation'] = DeclarativeLabelTranslation globals()['GeoAreaConfig'] = GeoAreaConfig + globals()['ObjectConditionalFormatting'] = ObjectConditionalFormatting class DeclarativeLabel(ModelNormal): @@ -132,6 +134,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 + 'conditional_formatting': (ObjectConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'geo_area_config': (GeoAreaConfig,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -153,6 +156,7 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 'title': 'title', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'geo_area_config': 'geoAreaConfig', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -211,6 +215,7 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 description (str): Label description.. [optional] # noqa: E501 geo_area_config (GeoAreaConfig): [optional] # noqa: E501 is_hidden (bool): Determines if the label is hidden from AI features.. [optional] # noqa: E501 @@ -313,6 +318,7 @@ def __init__(self, id, title, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 description (str): Label description.. [optional] # noqa: E501 geo_area_config (GeoAreaConfig): [optional] # noqa: E501 is_hidden (bool): Determines if the label is hidden from AI features.. [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 943f806a2..59635cf7d 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_metric.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_metric.py @@ -33,8 +33,10 @@ def lazy_import(): 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()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier globals()['JsonNode'] = JsonNode + globals()['ObjectConditionalFormatting'] = ObjectConditionalFormatting class DeclarativeMetric(ModelNormal): @@ -128,6 +130,7 @@ def openapi_types(): 'certification_message': (str, none_type,), # noqa: E501 'certified_at': (str, none_type,), # noqa: E501 'certified_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'conditional_formatting': (ObjectConditionalFormatting,), # noqa: E501 'created_at': (str, none_type,), # noqa: E501 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 'description': (str,), # noqa: E501 @@ -151,6 +154,7 @@ def discriminator(): 'certification_message': 'certificationMessage', # noqa: E501 'certified_at': 'certifiedAt', # noqa: E501 'certified_by': 'certifiedBy', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'description': 'description', # noqa: E501 @@ -211,6 +215,7 @@ def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (str, none_type): Time when the certification was set.. [optional] # noqa: E501 certified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Metric description.. [optional] # noqa: E501 @@ -316,6 +321,7 @@ def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (str, none_type): Time when the certification was set.. [optional] # noqa: E501 certified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + conditional_formatting (ObjectConditionalFormatting): [optional] # noqa: E501 created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Metric description.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/declarative_report.py similarity index 80% rename from gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py rename to gooddata-api-client/gooddata_api_client/model/declarative_report.py index d1d33f792..c53ec43ea 100644 --- a/gooddata-api-client/gooddata_api_client/model/rich_text_widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_report.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.filter_definition import FilterDefinition - globals()['FilterDefinition'] = FilterDefinition + from gooddata_api_client.model.json_node import JsonNode + globals()['JsonNode'] = JsonNode -class RichTextWidgetDescriptor(ModelNormal): +class DeclarativeReport(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -60,12 +60,22 @@ class RichTextWidgetDescriptor(ModelNormal): """ allowed_values = { - ('widget_type',): { - 'RICHTEXT': "richText", - }, } validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, + }, + ('description',): { + 'max_length': 10000, + }, + ('tags',): { + }, } @cached_property @@ -91,11 +101,14 @@ def openapi_types(): """ lazy_import() return { + 'content': (JsonNode,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'period_end': (date,), # noqa: E501 + 'period_start': (date,), # noqa: E501 'title': (str,), # noqa: E501 - 'widget_id': (str,), # noqa: E501 - 'widget_type': (str,), # noqa: E501 - 'content': (str,), # noqa: E501 - 'filters': ([FilterDefinition],), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'variable_values': ({str: (str,)},), # noqa: E501 } @cached_property @@ -104,11 +117,14 @@ def discriminator(): attribute_map = { - 'title': 'title', # noqa: E501 - 'widget_id': 'widgetId', # noqa: E501 - 'widget_type': 'widgetType', # noqa: E501 'content': 'content', # noqa: E501 - 'filters': 'filters', # noqa: E501 + 'id': 'id', # noqa: E501 + 'period_end': 'periodEnd', # noqa: E501 + 'period_start': 'periodStart', # noqa: E501 + 'title': 'title', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'variable_values': 'variableValues', # noqa: E501 } read_only_vars = { @@ -118,15 +134,17 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, title, widget_id, *args, **kwargs): # noqa: E501 - """RichTextWidgetDescriptor - a model defined in OpenAPI + def _from_openapi_data(cls, content, id, period_end, period_start, title, *args, **kwargs): # noqa: E501 + """DeclarativeReport - a model defined in OpenAPI Args: - title (str): Widget title as displayed on the dashboard. - widget_id (str): Widget object ID. + content (JsonNode): + id (str): Report ID. + period_end (date): Last day of the reported period, inclusive. + period_start (date): First day of the reported period, inclusive. + title (str): Report title. Keyword Args: - widget_type (str): defaults to "richText", must be one of ["richText", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -157,11 +175,11 @@ def _from_openapi_data(cls, title, widget_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,) - content (str): Markdown/text content of the rich text widget.. [optional] # noqa: E501 - filters ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 + description (str): Report description.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + variable_values ({str: (str,)}): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 """ - widget_type = kwargs.get('widget_type', "richText") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -191,9 +209,11 @@ def _from_openapi_data(cls, title, widget_id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.content = content + self.id = id + self.period_end = period_end + self.period_start = period_start self.title = title - self.widget_id = widget_id - self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -214,15 +234,17 @@ def _from_openapi_data(cls, title, widget_id, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, title, widget_id, *args, **kwargs): # noqa: E501 - """RichTextWidgetDescriptor - a model defined in OpenAPI + def __init__(self, content, id, period_end, period_start, title, *args, **kwargs): # noqa: E501 + """DeclarativeReport - a model defined in OpenAPI Args: - title (str): Widget title as displayed on the dashboard. - widget_id (str): Widget object ID. + content (JsonNode): + id (str): Report ID. + period_end (date): Last day of the reported period, inclusive. + period_start (date): First day of the reported period, inclusive. + title (str): Report title. Keyword Args: - widget_type (str): defaults to "richText", must be one of ["richText", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -253,11 +275,11 @@ def __init__(self, title, widget_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,) - content (str): Markdown/text content of the rich text widget.. [optional] # noqa: E501 - filters ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 + description (str): Report description.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + variable_values ({str: (str,)}): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 """ - widget_type = kwargs.get('widget_type', "richText") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -285,9 +307,11 @@ def __init__(self, title, widget_id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.content = content + self.id = id + self.period_end = period_end + self.period_start = period_start self.title = title - self.widget_id = widget_id - self.widget_type = widget_type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_report_page_layout.py b/gooddata-api-client/gooddata_api_client/model/declarative_report_page_layout.py new file mode 100644 index 000000000..5e1882ea4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_report_page_layout.py @@ -0,0 +1,309 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class DeclarativeReportPageLayout(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': (JsonNode,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'title': (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 + '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, *args, **kwargs): # noqa: E501 + """DeclarativeReportPageLayout - a model defined in OpenAPI + + Args: + content (JsonNode): + id (str): Report page layout ID. + title (str): Report page layout title. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Report page layout 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, *args, **kwargs): # noqa: E501 + """DeclarativeReportPageLayout - a model defined in OpenAPI + + Args: + content (JsonNode): + id (str): Report page layout ID. + title (str): Report page layout title. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Report page layout 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_template.py b/gooddata-api-client/gooddata_api_client/model/declarative_report_template.py new file mode 100644 index 000000000..37b154263 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/declarative_report_template.py @@ -0,0 +1,309 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class DeclarativeReportTemplate(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': (JsonNode,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'title': (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 + '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, *args, **kwargs): # noqa: E501 + """DeclarativeReportTemplate - a model defined in OpenAPI + + Args: + content (JsonNode): + id (str): Report template ID. + title (str): Report template title. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Report 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, *args, **kwargs): # noqa: E501 + """DeclarativeReportTemplate - a model defined in OpenAPI + + Args: + content (JsonNode): + id (str): Report template ID. + title (str): Report template title. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): Report 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_setting.py b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py index eeada2029..f9bf69d84 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_setting.py @@ -102,10 +102,12 @@ class DeclarativeSetting(ModelNormal): 'LDM_DEFAULT_LOCALE': "LDM_DEFAULT_LOCALE", 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", + 'CONVERSATION_RETENTION_DAYS': "CONVERSATION_RETENTION_DAYS", 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", 'SORT_COLLATION': "SORT_COLLATION", 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", + 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", @@ -114,6 +116,11 @@ class DeclarativeSetting(ModelNormal): 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", 'CERTIFY_PARENT_OBJECTS': "CERTIFY_PARENT_OBJECTS", 'HLL_TYPE': "HLL_TYPE", + 'ENABLE_TIMEZONE_CHANGE': "ENABLE_TIMEZONE_CHANGE", + 'AUTHORIZATION_SERVER_REDIRECT_POLICY': "AUTHORIZATION_SERVER_REDIRECT_POLICY", + 'DEFAULT_VISUALIZATION_VISIBILITY': "DEFAULT_VISUALIZATION_VISIBILITY", + 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", + 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py index 22902918f..7984b3242 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_single_workspace_permission.py @@ -72,6 +72,7 @@ class DeclarativeSingleWorkspacePermission(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", 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 0bfbaf70c..10a321dec 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 @@ -31,8 +31,10 @@ 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.json_node import JsonNode + globals()['ConditionalFormatting'] = ConditionalFormatting globals()['DeclarativeUserIdentifier'] = DeclarativeUserIdentifier globals()['JsonNode'] = JsonNode @@ -128,6 +130,7 @@ def openapi_types(): 'certification_message': (str, none_type,), # noqa: E501 'certified_at': (str, none_type,), # noqa: E501 'certified_by': (DeclarativeUserIdentifier,), # noqa: E501 + 'conditional_formatting': (ConditionalFormatting,), # noqa: E501 'created_at': (str, none_type,), # noqa: E501 'created_by': (DeclarativeUserIdentifier,), # noqa: E501 'description': (str,), # noqa: E501 @@ -150,6 +153,7 @@ def discriminator(): 'certification_message': 'certificationMessage', # noqa: E501 'certified_at': 'certifiedAt', # noqa: E501 'certified_by': 'certifiedBy', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'description': 'description', # noqa: E501 @@ -209,6 +213,7 @@ def _from_openapi_data(cls, content, id, title, *args, **kwargs): # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (str, none_type): Time when the certification was set.. [optional] # noqa: E501 certified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Visualization object description.. [optional] # noqa: E501 @@ -313,6 +318,7 @@ def __init__(self, content, id, title, *args, **kwargs): # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (str, none_type): Time when the certification was set.. [optional] # noqa: E501 certified_by (DeclarativeUserIdentifier): [optional] # noqa: E501 + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 created_at (str, none_type): Time of the entity creation.. [optional] # noqa: E501 created_by (DeclarativeUserIdentifier): [optional] # noqa: E501 description (str): Visualization object description.. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py index 0cbb2c13b..4b53f43dc 100644 --- a/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py +++ b/gooddata-api-client/gooddata_api_client/model/declarative_workspace_hierarchy_permission.py @@ -72,6 +72,7 @@ class DeclarativeWorkspaceHierarchyPermission(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", diff --git a/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py b/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py index 82d83b3ae..ebaa0a0a5 100644 --- a/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py +++ b/gooddata-api-client/gooddata_api_client/model/dependent_entities_node.py @@ -65,6 +65,7 @@ class DependentEntitiesNode(ModelNormal): 'FACT': "fact", 'LABEL': "label", 'METRIC': "metric", + 'COMPUTEDATTRIBUTE': "computedAttribute", 'USERDATAFILTER': "userDataFilter", 'PARAMETER': "parameter", 'AUTOMATION': "automation", diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on.py b/gooddata-api-client/gooddata_api_client/model/depends_on.py index 594528e43..055e17a7b 100644 --- a/gooddata-api-client/gooddata_api_client/model/depends_on.py +++ b/gooddata-api-client/gooddata_api_client/model/depends_on.py @@ -62,6 +62,10 @@ class DependsOn(ModelComposed): """ allowed_values = { + ('type',): { + 'LABEL': "label", + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, } validations = { @@ -93,6 +97,7 @@ def openapi_types(): 'label': (str,), # noqa: E501 'values': ([str, none_type],), # noqa: E501 'complement_filter': (bool,), # noqa: E501 + 'type': (str,), # noqa: E501 } @cached_property @@ -104,6 +109,7 @@ def discriminator(): 'label': 'label', # noqa: E501 'values': 'values', # noqa: E501 'complement_filter': 'complementFilter', # noqa: E501 + 'type': 'type', # noqa: E501 } read_only_vars = { @@ -148,6 +154,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -254,6 +261,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py b/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py index 664601750..65f3356ec 100644 --- a/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py +++ b/gooddata-api-client/gooddata_api_client/model/depends_on_all_of.py @@ -56,6 +56,10 @@ class DependsOnAllOf(ModelNormal): """ allowed_values = { + ('type',): { + 'LABEL': "label", + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, } validations = { @@ -84,6 +88,7 @@ def openapi_types(): return { 'complement_filter': (bool,), # noqa: E501 'label': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 'values': ([str, none_type],), # noqa: E501 } @@ -95,6 +100,7 @@ def discriminator(): attribute_map = { 'complement_filter': 'complementFilter', # noqa: E501 'label': 'label', # noqa: E501 + 'type': 'type', # noqa: E501 'values': 'values', # noqa: E501 } @@ -141,6 +147,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 """ @@ -229,6 +236,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/distribution_config.py b/gooddata-api-client/gooddata_api_client/model/distribution_config.py deleted file mode 100644 index 0b999b52b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/distribution_config.py +++ /dev/null @@ -1,273 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class DistributionConfig(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 { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - val = { - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """DistributionConfig - a model defined in OpenAPI - - Args: - 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,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """DistributionConfig - a model defined in OpenAPI - - Args: - 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,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/elements_request.py b/gooddata-api-client/gooddata_api_client/model/elements_request.py index 3315b048f..803c5ef88 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_request.py +++ b/gooddata-api-client/gooddata_api_client/model/elements_request.py @@ -68,6 +68,10 @@ class ElementsRequest(ModelNormal): 'ASC': "ASC", 'DESC': "DESC", }, + ('type',): { + 'LABEL': "label", + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, } validations = { @@ -112,6 +116,7 @@ def openapi_types(): 'pattern_filter': (str,), # noqa: E501 'sort_order': (str,), # noqa: E501 'timezone': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 'validate_by': ([ValidateByItem],), # noqa: E501 } @@ -132,6 +137,7 @@ def discriminator(): 'pattern_filter': 'patternFilter', # noqa: E501 'sort_order': 'sortOrder', # noqa: E501 'timezone': 'timezone', # noqa: E501 + 'type': 'type', # noqa: E501 'validate_by': 'validateBy', # noqa: E501 } @@ -189,6 +195,7 @@ def _from_openapi_data(cls, label, *args, **kwargs): # noqa: E501 pattern_filter (str): Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.. [optional] # noqa: E501 sort_order (str): Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default. [optional] # noqa: E501 timezone (str): Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.. [optional] # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 validate_by ([ValidateByItem]): Return only items that are computable on metric.. [optional] # noqa: E501 """ @@ -289,6 +296,7 @@ def __init__(self, label, *args, **kwargs): # noqa: E501 pattern_filter (str): Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.. [optional] # noqa: E501 sort_order (str): Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default. [optional] # noqa: E501 timezone (str): Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.. [optional] # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 validate_by ([ValidateByItem]): Return only items that are computable on metric.. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py b/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py index 5dde15dfd..885ae5f4d 100644 --- a/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py +++ b/gooddata-api-client/gooddata_api_client/model/elements_request_depends_on_inner.py @@ -68,6 +68,10 @@ class ElementsRequestDependsOnInner(ModelComposed): """ allowed_values = { + ('type',): { + 'LABEL': "label", + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, } validations = { @@ -97,6 +101,7 @@ def openapi_types(): lazy_import() return { 'complement_filter': (bool,), # noqa: E501 + 'type': (str,), # noqa: E501 'label': (str,), # noqa: E501 'values': ([str, none_type],), # noqa: E501 'date_filter': (DateFilter,), # noqa: E501 @@ -110,6 +115,7 @@ def discriminator(): attribute_map = { 'complement_filter': 'complementFilter', # noqa: E501 + 'type': 'type', # noqa: E501 'label': 'label', # noqa: E501 'values': 'values', # noqa: E501 'date_filter': 'dateFilter', # noqa: E501 @@ -156,6 +162,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 date_filter (DateFilter): [optional] # noqa: E501 @@ -264,6 +271,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) complement_filter (bool): Inverse filtering mode.. [optional] if omitted the server will use the default value of False # noqa: E501 + type (str): Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.. [optional] # noqa: E501 label (str): Specifies on which label the filter depends on.. [optional] # noqa: E501 values ([str, none_type]): Specifies values of the label for element filtering.. [optional] # noqa: E501 date_filter (DateFilter): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/entity_identifier.py b/gooddata-api-client/gooddata_api_client/model/entity_identifier.py index c86a033e0..ddbe536e8 100644 --- a/gooddata-api-client/gooddata_api_client/model/entity_identifier.py +++ b/gooddata-api-client/gooddata_api_client/model/entity_identifier.py @@ -65,6 +65,7 @@ class EntityIdentifier(ModelNormal): 'FACT': "fact", 'LABEL': "label", 'METRIC': "metric", + 'COMPUTEDATTRIBUTE': "computedAttribute", 'USERDATAFILTER': "userDataFilter", 'PARAMETER': "parameter", 'AUTOMATION': "automation", diff --git a/gooddata-api-client/gooddata_api_client/model/error_info.py b/gooddata-api-client/gooddata_api_client/model/error_info.py deleted file mode 100644 index ccea5f682..000000000 --- a/gooddata-api-client/gooddata_api_client/model/error_info.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ErrorInfo(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 { - 'reason': (str,), # noqa: E501 - 'status_code': (int,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'reason': 'reason', # noqa: E501 - 'status_code': 'statusCode', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, reason, status_code, *args, **kwargs): # noqa: E501 - """ErrorInfo - a model defined in OpenAPI - - Args: - reason (str): Stable machine-readable error code. Switch on this for localized client messages. - status_code (int): HTTP-like semantic status (e.g. 503 when the workspace is still syncing). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.reason = reason - self.status_code = status_code - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, reason, status_code, *args, **kwargs): # noqa: E501 - """ErrorInfo - a model defined in OpenAPI - - Args: - reason (str): Stable machine-readable error code. Switch on this for localized client messages. - status_code (int): HTTP-like semantic status (e.g. 503 when the workspace is still syncing). - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.reason = reason - self.status_code = status_code - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/export_request.py b/gooddata-api-client/gooddata_api_client/model/export_request.py index d6d569eec..1c059fcba 100644 --- a/gooddata-api-client/gooddata_api_client/model/export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/export_request.py @@ -31,6 +31,7 @@ def lazy_import(): + from gooddata_api_client.model.conditional_formatting import ConditionalFormatting from gooddata_api_client.model.custom_override import CustomOverride from gooddata_api_client.model.execution_settings import ExecutionSettings from gooddata_api_client.model.json_node import JsonNode @@ -39,6 +40,7 @@ def lazy_import(): from gooddata_api_client.model.tabular_export_execution import TabularExportExecution from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.visual_export_request import VisualExportRequest + globals()['ConditionalFormatting'] = ConditionalFormatting globals()['CustomOverride'] = CustomOverride globals()['ExecutionSettings'] = ExecutionSettings globals()['JsonNode'] = JsonNode @@ -110,6 +112,7 @@ def openapi_types(): return { 'metadata': (JsonNode,), # noqa: E501 'timezone_id': (str, none_type,), # noqa: E501 + 'conditional_formatting': (ConditionalFormatting,), # noqa: E501 'custom_override': (CustomOverride,), # noqa: E501 'execution_result': (str,), # noqa: E501 'execution_settings': (ExecutionSettings,), # noqa: E501 @@ -132,6 +135,7 @@ def discriminator(): attribute_map = { 'metadata': 'metadata', # noqa: E501 'timezone_id': 'timezoneId', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'custom_override': 'customOverride', # noqa: E501 'execution_result': 'executionResult', # noqa: E501 'execution_settings': 'executionSettings', # noqa: E501 @@ -187,6 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 execution_settings (ExecutionSettings): [optional] # noqa: E501 @@ -304,6 +309,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 execution_settings (ExecutionSettings): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/failed_operation.py b/gooddata-api-client/gooddata_api_client/model/failed_operation.py index c79f1f705..aa90bd9df 100644 --- a/gooddata-api-client/gooddata_api_client/model/failed_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/failed_operation.py @@ -71,10 +71,7 @@ class FailedOperation(ModelComposed): 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", - 'CREATE-PIPE-TABLE': "create-pipe-table", - 'DELETE-PIPE-TABLE': "delete-pipe-table", 'ANALYZE-STATISTICS': "analyze-statistics", - 'REFRESH-PARTITION': "refresh-partition", }, } @@ -137,7 +134,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 status (str): defaults to "failed", must be one of ["failed", ] # noqa: E501 error (OperationError): id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -245,7 +242,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 status (str): defaults to "failed", must be one of ["failed", ] # noqa: E501 error (OperationError): id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.py b/gooddata-api-client/gooddata_api_client/model/file_flow_input.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.py rename to gooddata-api-client/gooddata_api_client/model/file_flow_input.py index 41fb58cd0..9b0e35c79 100644 --- a/gooddata-api-client/gooddata_api_client/model/attribute_positive_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/file_flow_input.py @@ -31,13 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.attribute_positive_filter_all_of import AttributePositiveFilterAllOf - from gooddata_api_client.model.filter import Filter - globals()['AttributePositiveFilterAllOf'] = AttributePositiveFilterAllOf - globals()['Filter'] = Filter + from gooddata_api_client.model.file_flow_input_all_of import FileFlowInputAllOf + globals()['FileFlowInputAllOf'] = FileFlowInputAllOf -class AttributePositiveFilter(ModelComposed): +class FileFlowInput(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -62,6 +60,9 @@ class AttributePositiveFilter(ModelComposed): """ allowed_values = { + ('type',): { + 'FILE': "file", + }, } validations = { @@ -90,8 +91,9 @@ def openapi_types(): """ lazy_import() return { - 'include': ([str],), # noqa: E501 - 'using': (str,), # noqa: E501 + 'data_source_id': (str,), # noqa: E501 + 'table': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 } @cached_property @@ -100,8 +102,9 @@ def discriminator(): attribute_map = { - 'include': 'include', # noqa: E501 - 'using': 'using', # noqa: E501 + 'data_source_id': 'dataSourceId', # noqa: E501 + 'table': 'table', # noqa: E501 + 'type': 'type', # noqa: E501 } read_only_vars = { @@ -110,11 +113,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """AttributePositiveFilter - a model defined in OpenAPI + """FileFlowInput - a model defined in OpenAPI Keyword Args: - include ([str]): - using (str): + data_source_id (str): Identifier of the GDSTORAGE data source. + table (str): Name of the table in the data source. + type (str): Type of the input.. defaults to "file", must be one of ["file", ] # 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. @@ -147,6 +151,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "file") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -215,11 +220,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """AttributePositiveFilter - a model defined in OpenAPI + """FileFlowInput - a model defined in OpenAPI Keyword Args: - include ([str]): - using (str): + data_source_id (str): Identifier of the GDSTORAGE data source. + table (str): Name of the table in the data source. + type (str): Type of the input.. defaults to "file", must be one of ["file", ] # 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. @@ -252,6 +258,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "file") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -319,8 +326,7 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ - AttributePositiveFilterAllOf, - Filter, + FileFlowInputAllOf, ], 'oneOf': [ ], diff --git a/gooddata-api-client/gooddata_api_client/model/duplicate_key_config.py b/gooddata-api-client/gooddata_api_client/model/file_flow_input_all_of.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/duplicate_key_config.py rename to gooddata-api-client/gooddata_api_client/model/file_flow_input_all_of.py index 9c32fcf43..7a43d77b1 100644 --- a/gooddata-api-client/gooddata_api_client/model/duplicate_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/file_flow_input_all_of.py @@ -31,7 +31,7 @@ -class DuplicateKeyConfig(ModelNormal): +class FileFlowInputAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,7 +57,7 @@ class DuplicateKeyConfig(ModelNormal): allowed_values = { ('type',): { - 'DUPLICATE': "duplicate", + 'FILE': "file", }, } @@ -85,8 +85,9 @@ def openapi_types(): and the value is attribute type. """ return { + 'data_source_id': (str,), # noqa: E501 + 'table': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'columns': ([str],), # noqa: E501 } @cached_property @@ -95,8 +96,9 @@ def discriminator(): attribute_map = { + 'data_source_id': 'dataSourceId', # noqa: E501 + 'table': 'table', # noqa: E501 'type': 'type', # noqa: E501 - 'columns': 'columns', # noqa: E501 } read_only_vars = { @@ -107,12 +109,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """DuplicateKeyConfig - a model defined in OpenAPI - - Args: + """FileFlowInputAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "duplicate", must be one of ["duplicate", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -143,10 +142,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + data_source_id (str): Identifier of the GDSTORAGE data source.. [optional] # noqa: E501 + table (str): Name of the table in the data source.. [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "file" # noqa: E501 """ - type = kwargs.get('type', "duplicate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -176,7 +176,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,12 +197,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """DuplicateKeyConfig - a model defined in OpenAPI - - Args: + """FileFlowInputAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "duplicate", must be one of ["duplicate", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -234,10 +230,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + data_source_id (str): Identifier of the GDSTORAGE data source.. [optional] # noqa: E501 + table (str): Name of the table in the data source.. [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "file" # noqa: E501 """ - type = kwargs.get('type', "duplicate") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -265,7 +262,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_item_pipe_table.py b/gooddata-api-client/gooddata_api_client/model/flow_column.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/json_api_item_pipe_table.py rename to gooddata-api-client/gooddata_api_client/model/flow_column.py index 6130cef63..d81677616 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_item_pipe_table.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_column.py @@ -30,12 +30,8 @@ from gooddata_api_client.exceptions import ApiAttributeError -def lazy_import(): - from gooddata_api_client.model.pipe_table import PipeTable - globals()['PipeTable'] = PipeTable - -class JsonApiItemPipeTable(ModelNormal): +class FlowColumn(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -71,7 +67,6 @@ def additional_properties_type(): 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 @@ -86,10 +81,9 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ - lazy_import() return { - 'attributes': (PipeTable,), # noqa: E501 - 'id': (str,), # noqa: E501 + 'metadata': ({str: (str,)},), # noqa: E501 + 'name': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -99,8 +93,8 @@ def discriminator(): attribute_map = { - 'attributes': 'attributes', # noqa: E501 - 'id': 'id', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'name': 'name', # noqa: E501 'type': 'type', # noqa: E501 } @@ -111,13 +105,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, type, *args, **kwargs): # noqa: E501 - """JsonApiItemPipeTable - a model defined in OpenAPI + def _from_openapi_data(cls, metadata, name, type, *args, **kwargs): # noqa: E501 + """FlowColumn - a model defined in OpenAPI Args: - attributes (PipeTable): - id (str): Resource identifier - type (str): Resource type + metadata ({str: (str,)}): Metadata of the column, as the operation that produced it gives them. + name (str): Name of the column. + type (str): Type of the values in the column. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -181,8 +175,8 @@ def _from_openapi_data(cls, attributes, id, type, *args, **kwargs): # noqa: E50 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes - self.id = id + self.metadata = metadata + self.name = name self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -204,13 +198,13 @@ def _from_openapi_data(cls, attributes, id, type, *args, **kwargs): # noqa: E50 ]) @convert_js_args_to_python_args - def __init__(self, attributes, id, type, *args, **kwargs): # noqa: E501 - """JsonApiItemPipeTable - a model defined in OpenAPI + def __init__(self, metadata, name, type, *args, **kwargs): # noqa: E501 + """FlowColumn - a model defined in OpenAPI Args: - attributes (PipeTable): - id (str): Resource identifier - type (str): Resource type + metadata ({str: (str,)}): Metadata of the column, as the operation that produced it gives them. + name (str): Name of the column. + type (str): Type of the values in the column. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -272,8 +266,8 @@ def __init__(self, attributes, id, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.attributes = attributes - self.id = id + self.metadata = metadata + self.name = name self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/ui_context.py b/gooddata-api-client/gooddata_api_client/model/flow_execution_response.py similarity index 94% rename from gooddata-api-client/gooddata_api_client/model/ui_context.py rename to gooddata-api-client/gooddata_api_client/model/flow_execution_response.py index f92c03bf9..2d9f18907 100644 --- a/gooddata-api-client/gooddata_api_client/model/ui_context.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_execution_response.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.dashboard_context import DashboardContext - globals()['DashboardContext'] = DashboardContext + from gooddata_api_client.model.execution_links import ExecutionLinks + globals()['ExecutionLinks'] = ExecutionLinks -class UIContext(ModelNormal): +class FlowExecutionResponse(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -88,7 +88,7 @@ def openapi_types(): """ lazy_import() return { - 'dashboard': (DashboardContext,), # noqa: E501 + 'links': (ExecutionLinks,), # noqa: E501 } @cached_property @@ -97,7 +97,7 @@ def discriminator(): attribute_map = { - 'dashboard': 'dashboard', # noqa: E501 + 'links': 'links', # noqa: E501 } read_only_vars = { @@ -107,8 +107,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """UIContext - a model defined in OpenAPI + def _from_openapi_data(cls, links, *args, **kwargs): # noqa: E501 + """FlowExecutionResponse - a model defined in OpenAPI + + Args: + links (ExecutionLinks): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,7 +144,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dashboard (DashboardContext): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -173,6 +175,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.links = links for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -193,8 +196,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UIContext - a model defined in OpenAPI + def __init__(self, links, *args, **kwargs): # noqa: E501 + """FlowExecutionResponse - a model defined in OpenAPI + + Args: + links (ExecutionLinks): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -227,7 +233,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dashboard (DashboardContext): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -257,6 +262,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.links = links 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/create_pipe_table_request_partition_config.py b/gooddata-api-client/gooddata_api_client/model/flow_input.py similarity index 84% rename from gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_partition_config.py rename to gooddata-api-client/gooddata_api_client/model/flow_input.py index 19be4da1d..360ebb0c7 100644 --- a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_partition_config.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_input.py @@ -31,15 +31,19 @@ def lazy_import(): - from gooddata_api_client.model.column_partition_config import ColumnPartitionConfig - from gooddata_api_client.model.date_trunc_partition_config import DateTruncPartitionConfig - from gooddata_api_client.model.time_slice_partition_config import TimeSlicePartitionConfig - globals()['ColumnPartitionConfig'] = ColumnPartitionConfig - globals()['DateTruncPartitionConfig'] = DateTruncPartitionConfig - globals()['TimeSlicePartitionConfig'] = TimeSlicePartitionConfig - - -class CreatePipeTableRequestPartitionConfig(ModelComposed): + from gooddata_api_client.model.afm import AFM + from gooddata_api_client.model.afm_flow_input import AfmFlowInput + from gooddata_api_client.model.execution_settings import ExecutionSettings + from gooddata_api_client.model.file_flow_input import FileFlowInput + from gooddata_api_client.model.sql_flow_input import SqlFlowInput + globals()['AFM'] = AFM + globals()['AfmFlowInput'] = AfmFlowInput + globals()['ExecutionSettings'] = ExecutionSettings + globals()['FileFlowInput'] = FileFlowInput + globals()['SqlFlowInput'] = SqlFlowInput + + +class FlowInput(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -65,26 +69,11 @@ class CreatePipeTableRequestPartitionConfig(ModelComposed): allowed_values = { ('type',): { - 'TIMESLICE': "timeSlice", - }, - ('unit',): { - 'YEAR': "year", - 'QUARTER': "quarter", - 'MONTH': "month", - 'WEEK': "week", - 'DAY': "day", - 'HOUR': "hour", - 'MINUTE': "minute", - 'SECOND': "second", - 'MILLISECOND': "millisecond", - 'MICROSECOND': "microsecond", + 'SQL': "sql", }, } validations = { - ('slices',): { - 'inclusive_minimum': 1, - }, } @cached_property @@ -110,11 +99,12 @@ def openapi_types(): """ lazy_import() return { - 'columns': ([str],), # noqa: E501 + 'settings': (ExecutionSettings,), # noqa: E501 + 'data_source_id': (str,), # noqa: E501 + 'table': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'column': (str,), # noqa: E501 - 'unit': (str,), # noqa: E501 - 'slices': (int,), # noqa: E501 + 'execution': (AFM,), # noqa: E501 + 'sql': (str,), # noqa: E501 } @cached_property @@ -123,11 +113,12 @@ def discriminator(): attribute_map = { - 'columns': 'columns', # noqa: E501 + 'settings': 'settings', # noqa: E501 + 'data_source_id': 'dataSourceId', # noqa: E501 + 'table': 'table', # noqa: E501 'type': 'type', # noqa: E501 - 'column': 'column', # noqa: E501 - 'unit': 'unit', # noqa: E501 - 'slices': 'slices', # noqa: E501 + 'execution': 'execution', # noqa: E501 + 'sql': 'sql', # noqa: E501 } read_only_vars = { @@ -136,7 +127,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequestPartitionConfig - a model defined in OpenAPI + """FlowInput - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -169,11 +160,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Columns to partition by.. [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "timeSlice" # noqa: E501 - column (str): Column to partition on.. [optional] # noqa: E501 - unit (str): Date/time unit for partition granularity. [optional] # noqa: E501 - slices (int): How many units per slice.. [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 + data_source_id (str): Identifier of the data source that runs the statement.. [optional] # noqa: E501 + table (str): Name of the table in the data source.. [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "sql" # noqa: E501 + execution (AFM): [optional] # noqa: E501 + sql (str): One SELECT statement in the SQL dialect of the data source.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -244,7 +236,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequestPartitionConfig - a model defined in OpenAPI + """FlowInput - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -277,11 +269,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Columns to partition by.. [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "timeSlice" # noqa: E501 - column (str): Column to partition on.. [optional] # noqa: E501 - unit (str): Date/time unit for partition granularity. [optional] # noqa: E501 - slices (int): How many units per slice.. [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 + data_source_id (str): Identifier of the data source that runs the statement.. [optional] # noqa: E501 + table (str): Name of the table in the data source.. [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "sql" # noqa: E501 + execution (AFM): [optional] # noqa: E501 + sql (str): One SELECT statement in the SQL dialect of the data source.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -353,8 +346,8 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ - ColumnPartitionConfig, - DateTruncPartitionConfig, - TimeSlicePartitionConfig, + AfmFlowInput, + FileFlowInput, + SqlFlowInput, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/created_visualizations.py b/gooddata-api-client/gooddata_api_client/model/flow_operation_descriptor.py similarity index 79% rename from gooddata-api-client/gooddata_api_client/model/created_visualizations.py rename to gooddata-api-client/gooddata_api_client/model/flow_operation_descriptor.py index eaffc70be..0da1049f8 100644 --- a/gooddata-api-client/gooddata_api_client/model/created_visualizations.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_operation_descriptor.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.created_visualization import CreatedVisualization - from gooddata_api_client.model.suggestion import Suggestion - globals()['CreatedVisualization'] = CreatedVisualization - globals()['Suggestion'] = Suggestion + from gooddata_api_client.model.flow_operation_input import FlowOperationInput + from gooddata_api_client.model.flow_operation_output import FlowOperationOutput + globals()['FlowOperationInput'] = FlowOperationInput + globals()['FlowOperationOutput'] = FlowOperationOutput -class CreatedVisualizations(ModelNormal): +class FlowOperationDescriptor(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -90,9 +90,12 @@ def openapi_types(): """ lazy_import() return { - 'objects': ([CreatedVisualization],), # noqa: E501 - 'reasoning': (str,), # noqa: E501 - 'suggestions': ([Suggestion],), # noqa: E501 + 'description': (str,), # noqa: E501 + 'inputs': ([FlowOperationInput],), # noqa: E501 + 'name': (str,), # noqa: E501 + 'output': (FlowOperationOutput,), # noqa: E501 + 'parameters': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'pure': (bool,), # noqa: E501 } @cached_property @@ -101,9 +104,12 @@ def discriminator(): attribute_map = { - 'objects': 'objects', # noqa: E501 - 'reasoning': 'reasoning', # noqa: E501 - 'suggestions': 'suggestions', # noqa: E501 + 'description': 'description', # noqa: E501 + 'inputs': 'inputs', # noqa: E501 + 'name': 'name', # noqa: E501 + 'output': 'output', # noqa: E501 + 'parameters': 'parameters', # noqa: E501 + 'pure': 'pure', # noqa: E501 } read_only_vars = { @@ -113,13 +119,16 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, objects, reasoning, suggestions, *args, **kwargs): # noqa: E501 - """CreatedVisualizations - a model defined in OpenAPI + def _from_openapi_data(cls, description, inputs, name, output, parameters, pure, *args, **kwargs): # noqa: E501 + """FlowOperationDescriptor - a model defined in OpenAPI Args: - objects ([CreatedVisualization]): List of created visualization objects - reasoning (str): DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. - suggestions ([Suggestion]): List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. + description (str): What the operation does. + inputs ([FlowOperationInput]): Inputs of the operation. The first one is the primary input, named data. + name (str): Name of the operation. A transformation gives it as its operation. + output (FlowOperationOutput): + parameters ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): JSON Schema of the parameters of the operation. + pure (bool): True when the result depends only on the inputs and the parameters. The result of an impure operation is never reused. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -183,9 +192,12 @@ def _from_openapi_data(cls, objects, reasoning, suggestions, *args, **kwargs): self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.objects = objects - self.reasoning = reasoning - self.suggestions = suggestions + self.description = description + self.inputs = inputs + self.name = name + self.output = output + self.parameters = parameters + self.pure = pure for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -206,13 +218,16 @@ def _from_openapi_data(cls, objects, reasoning, suggestions, *args, **kwargs): ]) @convert_js_args_to_python_args - def __init__(self, objects, reasoning, suggestions, *args, **kwargs): # noqa: E501 - """CreatedVisualizations - a model defined in OpenAPI + def __init__(self, description, inputs, name, output, parameters, pure, *args, **kwargs): # noqa: E501 + """FlowOperationDescriptor - a model defined in OpenAPI Args: - objects ([CreatedVisualization]): List of created visualization objects - reasoning (str): DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated. - suggestions ([Suggestion]): List of suggestions for next steps. Filled when no visualization was created, suggests alternatives. + description (str): What the operation does. + inputs ([FlowOperationInput]): Inputs of the operation. The first one is the primary input, named data. + name (str): Name of the operation. A transformation gives it as its operation. + output (FlowOperationOutput): + parameters ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): JSON Schema of the parameters of the operation. + pure (bool): True when the result depends only on the inputs and the parameters. The result of an impure operation is never reused. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -274,9 +289,12 @@ def __init__(self, objects, reasoning, suggestions, *args, **kwargs): # noqa: E self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.objects = objects - self.reasoning = reasoning - self.suggestions = suggestions + self.description = description + self.inputs = inputs + self.name = name + self.output = output + self.parameters = parameters + self.pure = pure 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/column_info.py b/gooddata-api-client/gooddata_api_client/model/flow_operation_input.py similarity index 93% rename from gooddata-api-client/gooddata_api_client/model/column_info.py rename to gooddata-api-client/gooddata_api_client/model/flow_operation_input.py index 3ccd5d43d..673b81bf6 100644 --- a/gooddata-api-client/gooddata_api_client/model/column_info.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_operation_input.py @@ -31,7 +31,7 @@ -class ColumnInfo(ModelNormal): +class FlowOperationInput(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -82,8 +82,8 @@ def openapi_types(): and the value is attribute type. """ return { + 'description': (str,), # noqa: E501 'name': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 } @cached_property @@ -92,8 +92,8 @@ def discriminator(): attribute_map = { + 'description': 'description', # noqa: E501 'name': 'name', # noqa: E501 - 'type': 'type', # noqa: E501 } read_only_vars = { @@ -103,12 +103,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, name, type, *args, **kwargs): # noqa: E501 - """ColumnInfo - a model defined in OpenAPI + def _from_openapi_data(cls, description, name, *args, **kwargs): # noqa: E501 + """FlowOperationInput - a model defined in OpenAPI Args: - name (str): Column name - type (str): SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE) + description (str): What the operation expects in the input. + name (str): Name of the input. A transformation binds it in its inputRefs. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -172,8 +172,8 @@ def _from_openapi_data(cls, name, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.description = description 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 \ @@ -194,12 +194,12 @@ def _from_openapi_data(cls, name, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, name, type, *args, **kwargs): # noqa: E501 - """ColumnInfo - a model defined in OpenAPI + def __init__(self, description, name, *args, **kwargs): # noqa: E501 + """FlowOperationInput - a model defined in OpenAPI Args: - name (str): Column name - type (str): SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE) + description (str): What the operation expects in the input. + name (str): Name of the input. A transformation binds it in its inputRefs. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -261,8 +261,8 @@ def __init__(self, name, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.description = description 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/thought.py b/gooddata-api-client/gooddata_api_client/model/flow_operation_output.py similarity index 94% rename from gooddata-api-client/gooddata_api_client/model/thought.py rename to gooddata-api-client/gooddata_api_client/model/flow_operation_output.py index d523031cc..be3e9289d 100644 --- a/gooddata-api-client/gooddata_api_client/model/thought.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_operation_output.py @@ -31,7 +31,7 @@ -class Thought(ModelNormal): +class FlowOperationOutput(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -82,7 +82,7 @@ def openapi_types(): and the value is attribute type. """ return { - 'text': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 } @cached_property @@ -91,7 +91,7 @@ def discriminator(): attribute_map = { - 'text': 'text', # noqa: E501 + 'description': 'description', # noqa: E501 } read_only_vars = { @@ -101,11 +101,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 - """Thought - a model defined in OpenAPI + def _from_openapi_data(cls, description, *args, **kwargs): # noqa: E501 + """FlowOperationOutput - a model defined in OpenAPI Args: - text (str): The text content of this thought. + description (str): What the operation produces. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -169,7 +169,7 @@ def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.text = text + self.description = description for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -190,11 +190,11 @@ def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, text, *args, **kwargs): # noqa: E501 - """Thought - a model defined in OpenAPI + def __init__(self, description, *args, **kwargs): # noqa: E501 + """FlowOperationOutput - a model defined in OpenAPI Args: - text (str): The text content of this thought. + description (str): What the operation produces. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -256,7 +256,7 @@ def __init__(self, text, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.text = text + self.description = description 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/flow_operations.py b/gooddata-api-client/gooddata_api_client/model/flow_operations.py new file mode 100644 index 000000000..fe2219d21 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/flow_operations.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.flow_operation_descriptor import FlowOperationDescriptor + globals()['FlowOperationDescriptor'] = FlowOperationDescriptor + + +class FlowOperations(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 { + 'operations': ([FlowOperationDescriptor],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'operations': 'operations', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, operations, *args, **kwargs): # noqa: E501 + """FlowOperations - a model defined in OpenAPI + + Args: + operations ([FlowOperationDescriptor]): Available operations. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.operations = operations + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, operations, *args, **kwargs): # noqa: E501 + """FlowOperations - a model defined in OpenAPI + + Args: + operations ([FlowOperationDescriptor]): Available operations. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.operations = operations + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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/reasoning_step.py b/gooddata-api-client/gooddata_api_client/model/flow_request.py similarity index 88% rename from gooddata-api-client/gooddata_api_client/model/reasoning_step.py rename to gooddata-api-client/gooddata_api_client/model/flow_request.py index d97650061..2ebd37879 100644 --- a/gooddata-api-client/gooddata_api_client/model/reasoning_step.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_request.py @@ -31,11 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.thought import Thought - globals()['Thought'] = Thought + from gooddata_api_client.model.flow_input import FlowInput + from gooddata_api_client.model.flow_transformation import FlowTransformation + globals()['FlowInput'] = FlowInput + globals()['FlowTransformation'] = FlowTransformation -class ReasoningStep(ModelNormal): +class FlowRequest(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -88,8 +90,8 @@ def openapi_types(): """ lazy_import() return { - 'thoughts': ([Thought],), # noqa: E501 - 'title': (str,), # noqa: E501 + 'inputs': ({str: (FlowInput,)},), # noqa: E501 + 'transformations': ([FlowTransformation],), # noqa: E501 } @cached_property @@ -98,8 +100,8 @@ def discriminator(): attribute_map = { - 'thoughts': 'thoughts', # noqa: E501 - 'title': 'title', # noqa: E501 + 'inputs': 'inputs', # noqa: E501 + 'transformations': 'transformations', # noqa: E501 } read_only_vars = { @@ -109,12 +111,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, thoughts, title, *args, **kwargs): # noqa: E501 - """ReasoningStep - a model defined in OpenAPI + def _from_openapi_data(cls, inputs, *args, **kwargs): # noqa: E501 + """FlowRequest - a model defined in OpenAPI Args: - thoughts ([Thought]): Detailed thoughts/messages within this step. - title (str): Title describing this reasoning step. + inputs ({str: (FlowInput,)}): Inputs of the flow by name. A transformation refers to an input by its name. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -147,6 +148,7 @@ def _from_openapi_data(cls, thoughts, title, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + transformations ([FlowTransformation]): Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -178,8 +180,7 @@ def _from_openapi_data(cls, thoughts, title, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.thoughts = thoughts - self.title = title + self.inputs = inputs for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -200,12 +201,11 @@ def _from_openapi_data(cls, thoughts, title, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, thoughts, title, *args, **kwargs): # noqa: E501 - """ReasoningStep - a model defined in OpenAPI + def __init__(self, inputs, *args, **kwargs): # noqa: E501 + """FlowRequest - a model defined in OpenAPI Args: - thoughts ([Thought]): Detailed thoughts/messages within this step. - title (str): Title describing this reasoning step. + inputs ({str: (FlowInput,)}): Inputs of the flow by name. A transformation refers to an input by its name. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -238,6 +238,7 @@ def __init__(self, thoughts, title, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + transformations ([FlowTransformation]): Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -267,8 +268,7 @@ def __init__(self, thoughts, title, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.thoughts = thoughts - self.title = title + self.inputs = inputs 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/widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/flow_result_metadata.py similarity index 88% rename from gooddata-api-client/gooddata_api_client/model/widget_descriptor.py rename to gooddata-api-client/gooddata_api_client/model/flow_result_metadata.py index fa4f3dbfc..10cdffb61 100644 --- a/gooddata-api-client/gooddata_api_client/model/widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_result_metadata.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.filter_definition import FilterDefinition - globals()['FilterDefinition'] = FilterDefinition + from gooddata_api_client.model.flow_column import FlowColumn + globals()['FlowColumn'] = FlowColumn -class WidgetDescriptor(ModelNormal): +class FlowResultMetadata(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -88,25 +88,20 @@ def openapi_types(): """ lazy_import() return { - 'title': (str,), # noqa: E501 - 'widget_id': (str,), # noqa: E501 - 'widget_type': (str,), # noqa: E501 - 'filters': ([FilterDefinition],), # noqa: E501 + 'columns': ([FlowColumn],), # noqa: E501 + 'metadata': ({str: (str,)},), # noqa: E501 + 'total_rows': (int,), # noqa: E501 } @cached_property def discriminator(): - val = { - } - if not val: - return None - return {'widget_type': val} + return None + attribute_map = { - 'title': 'title', # noqa: E501 - 'widget_id': 'widgetId', # noqa: E501 - 'widget_type': 'widgetType', # noqa: E501 - 'filters': 'filters', # noqa: E501 + 'columns': 'columns', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'total_rows': 'totalRows', # noqa: E501 } read_only_vars = { @@ -116,13 +111,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, title, widget_id, widget_type, *args, **kwargs): # noqa: E501 - """WidgetDescriptor - a model defined in OpenAPI + def _from_openapi_data(cls, columns, metadata, total_rows, *args, **kwargs): # noqa: E501 + """FlowResultMetadata - a model defined in OpenAPI Args: - title (str): - widget_id (str): - widget_type (str): + columns ([FlowColumn]): Columns of the result, in order. + metadata ({str: (str,)}): Metadata of the result, as the operations that produced it give them. + total_rows (int): Number of rows in the result. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -155,7 +150,6 @@ def _from_openapi_data(cls, title, widget_id, widget_type, *args, **kwargs): # Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - filters ([FilterDefinition]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -187,9 +181,9 @@ def _from_openapi_data(cls, title, widget_id, widget_type, *args, **kwargs): # self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.title = title - self.widget_id = widget_id - self.widget_type = widget_type + self.columns = columns + self.metadata = metadata + self.total_rows = total_rows for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -210,13 +204,13 @@ def _from_openapi_data(cls, title, widget_id, widget_type, *args, **kwargs): # ]) @convert_js_args_to_python_args - def __init__(self, title, widget_id, widget_type, *args, **kwargs): # noqa: E501 - """WidgetDescriptor - a model defined in OpenAPI + def __init__(self, columns, metadata, total_rows, *args, **kwargs): # noqa: E501 + """FlowResultMetadata - a model defined in OpenAPI Args: - title (str): - widget_id (str): - widget_type (str): + columns ([FlowColumn]): Columns of the result, in order. + metadata ({str: (str,)}): Metadata of the result, as the operations that produced it give them. + total_rows (int): Number of rows in the result. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -249,7 +243,6 @@ def __init__(self, title, widget_id, widget_type, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - filters ([FilterDefinition]): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -279,9 +272,9 @@ def __init__(self, title, widget_id, widget_type, *args, **kwargs): # noqa: E50 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.title = title - self.widget_id = widget_id - self.widget_type = widget_type + self.columns = columns + self.metadata = metadata + self.total_rows = total_rows 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/active_object_identification.py b/gooddata-api-client/gooddata_api_client/model/flow_table_paging.py similarity index 82% rename from gooddata-api-client/gooddata_api_client/model/active_object_identification.py rename to gooddata-api-client/gooddata_api_client/model/flow_table_paging.py index 0007ef0c2..b577de09d 100644 --- a/gooddata-api-client/gooddata_api_client/model/active_object_identification.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_table_paging.py @@ -31,7 +31,7 @@ -class ActiveObjectIdentification(ModelNormal): +class FlowTablePaging(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -82,9 +82,12 @@ def openapi_types(): and the value is attribute type. """ return { - 'id': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 + 'column_limit': (int,), # noqa: E501 + 'column_offset': (int,), # noqa: E501 + 'row_limit': (int,), # noqa: E501 + 'row_offset': (int,), # noqa: E501 + 'total_columns': (int,), # noqa: E501 + 'total_rows': (int,), # noqa: E501 } @cached_property @@ -93,9 +96,12 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'type': 'type', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 + 'column_limit': 'columnLimit', # noqa: E501 + 'column_offset': 'columnOffset', # noqa: E501 + 'row_limit': 'rowLimit', # noqa: E501 + 'row_offset': 'rowOffset', # noqa: E501 + 'total_columns': 'totalColumns', # noqa: E501 + 'total_rows': 'totalRows', # noqa: E501 } read_only_vars = { @@ -105,13 +111,16 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, workspace_id, *args, **kwargs): # noqa: E501 - """ActiveObjectIdentification - a model defined in OpenAPI + def _from_openapi_data(cls, column_limit, column_offset, row_limit, row_offset, total_columns, total_rows, *args, **kwargs): # noqa: E501 + """FlowTablePaging - a model defined in OpenAPI Args: - id (str): Object ID. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. + column_limit (int): Maximum number of columns in the page. + column_offset (int): Index of the first column of the page. + row_limit (int): Maximum number of rows in the page. + row_offset (int): Index of the first row of the page. + total_columns (int): Number of columns in the result. + total_rows (int): Number of rows in the result. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -175,9 +184,12 @@ def _from_openapi_data(cls, id, type, workspace_id, *args, **kwargs): # noqa: E self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.type = type - self.workspace_id = workspace_id + self.column_limit = column_limit + self.column_offset = column_offset + self.row_limit = row_limit + self.row_offset = row_offset + self.total_columns = total_columns + self.total_rows = total_rows for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,13 +210,16 @@ def _from_openapi_data(cls, id, type, workspace_id, *args, **kwargs): # noqa: E ]) @convert_js_args_to_python_args - def __init__(self, id, type, workspace_id, *args, **kwargs): # noqa: E501 - """ActiveObjectIdentification - a model defined in OpenAPI + def __init__(self, column_limit, column_offset, row_limit, row_offset, total_columns, total_rows, *args, **kwargs): # noqa: E501 + """FlowTablePaging - a model defined in OpenAPI Args: - id (str): Object ID. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. + column_limit (int): Maximum number of columns in the page. + column_offset (int): Index of the first column of the page. + row_limit (int): Maximum number of rows in the page. + row_offset (int): Index of the first row of the page. + total_columns (int): Number of columns in the result. + total_rows (int): Number of rows in the result. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -266,9 +281,12 @@ def __init__(self, id, type, workspace_id, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.type = type - self.workspace_id = workspace_id + self.column_limit = column_limit + self.column_offset = column_offset + self.row_limit = row_limit + self.row_offset = row_offset + self.total_columns = total_columns + self.total_rows = total_rows for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_list_document_pipe_table_summary.py b/gooddata-api-client/gooddata_api_client/model/flow_table_result.py similarity index 87% rename from gooddata-api-client/gooddata_api_client/model/json_api_list_document_pipe_table_summary.py rename to gooddata-api-client/gooddata_api_client/model/flow_table_result.py index c61fc1e0c..4ca255e38 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_list_document_pipe_table_summary.py +++ b/gooddata-api-client/gooddata_api_client/model/flow_table_result.py @@ -31,15 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_item_pipe_table_summary import JsonApiItemPipeTableSummary - from gooddata_api_client.model.json_api_list_links import JsonApiListLinks - from gooddata_api_client.model.json_api_list_meta import JsonApiListMeta - globals()['JsonApiItemPipeTableSummary'] = JsonApiItemPipeTableSummary - globals()['JsonApiListLinks'] = JsonApiListLinks - globals()['JsonApiListMeta'] = JsonApiListMeta + from gooddata_api_client.model.flow_column import FlowColumn + from gooddata_api_client.model.flow_table_paging import FlowTablePaging + globals()['FlowColumn'] = FlowColumn + globals()['FlowTablePaging'] = FlowTablePaging -class JsonApiListDocumentPipeTableSummary(ModelNormal): +class FlowTableResult(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -92,9 +90,9 @@ def openapi_types(): """ lazy_import() return { - 'data': ([JsonApiItemPipeTableSummary],), # noqa: E501 - 'links': (JsonApiListLinks,), # noqa: E501 - 'meta': (JsonApiListMeta,), # noqa: E501 + 'columns': ([FlowColumn],), # noqa: E501 + 'data': ([[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]],), # noqa: E501 + 'paging': (FlowTablePaging,), # noqa: E501 } @cached_property @@ -103,9 +101,9 @@ def discriminator(): attribute_map = { + 'columns': 'columns', # noqa: E501 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 - 'meta': 'meta', # noqa: E501 + 'paging': 'paging', # noqa: E501 } read_only_vars = { @@ -115,12 +113,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 - """JsonApiListDocumentPipeTableSummary - a model defined in OpenAPI + def _from_openapi_data(cls, columns, data, paging, *args, **kwargs): # noqa: E501 + """FlowTableResult - a model defined in OpenAPI Args: - data ([JsonApiItemPipeTableSummary]): Array of resource items - links (JsonApiListLinks): + columns ([FlowColumn]): Columns of the page, in order. + data ([[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]): Rows of the page. A row has one value for each column, in the order of the columns. + paging (FlowTablePaging): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -153,7 +152,6 @@ def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -185,8 +183,9 @@ def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.columns = columns self.data = data - self.links = links + self.paging = paging for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -207,12 +206,13 @@ def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, data, links, *args, **kwargs): # noqa: E501 - """JsonApiListDocumentPipeTableSummary - a model defined in OpenAPI + def __init__(self, columns, data, paging, *args, **kwargs): # noqa: E501 + """FlowTableResult - a model defined in OpenAPI Args: - data ([JsonApiItemPipeTableSummary]): Array of resource items - links (JsonApiListLinks): + columns ([FlowColumn]): Columns of the page, in order. + data ([[{str: (bool, date, datetime, dict, float, int, list, str, none_type)}]]): Rows of the page. A row has one value for each column, in the order of the columns. + paging (FlowTablePaging): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -245,7 +245,6 @@ def __init__(self, data, links, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -275,8 +274,9 @@ def __init__(self, data, links, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.columns = columns self.data = data - self.links = links + self.paging = paging 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/flow_transformation.py b/gooddata-api-client/gooddata_api_client/model/flow_transformation.py new file mode 100644 index 000000000..8352597ca --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/flow_transformation.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 FlowTransformation(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 { + 'operation': (str,), # noqa: E501 + 'id': (str, none_type,), # noqa: E501 + 'input_refs': ({str: (str,)},), # noqa: E501 + 'parameters': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'operation': 'operation', # noqa: E501 + 'id': 'id', # noqa: E501 + 'input_refs': 'inputRefs', # noqa: E501 + 'parameters': 'parameters', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, operation, *args, **kwargs): # noqa: E501 + """FlowTransformation - a model defined in OpenAPI + + Args: + operation (str): Name of the operation, as the operation catalog lists it. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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, none_type): Identifier of the transformation. Give it when a later transformation refers to it. The identifier does not change the result.. [optional] # noqa: E501 + input_refs ({str: (str,)}): Inputs of the operation by name. Each one refers to a flow input or to an earlier transformation. The primary input is named data. When data is not given, it refers to the previous transformation, or to the only flow input for the first transformation.. [optional] # noqa: E501 + parameters ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Parameters of the operation. They must match the parameter schema of the operation.. [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.operation = operation + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, operation, *args, **kwargs): # noqa: E501 + """FlowTransformation - a model defined in OpenAPI + + Args: + operation (str): Name of the operation, as the operation catalog lists it. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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, none_type): Identifier of the transformation. Give it when a later transformation refers to it. The identifier does not change the result.. [optional] # noqa: E501 + input_refs ({str: (str,)}): Inputs of the operation by name. Each one refers to a flow input or to an earlier transformation. The primary input is named data. When data is not given, it refers to the previous transformation, or to the only flow input for the first transformation.. [optional] # noqa: E501 + parameters ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Parameters of the operation. They must match the parameter schema of the operation.. [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.operation = operation + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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/forecast_config.py b/gooddata-api-client/gooddata_api_client/model/forecast_config.py deleted file mode 100644 index eeabd896f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/forecast_config.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class ForecastConfig(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 { - 'confidence_level': (float,), # noqa: E501 - 'forecast_period': (int,), # noqa: E501 - 'seasonal': (bool,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'confidence_level': 'confidenceLevel', # noqa: E501 - 'forecast_period': 'forecastPeriod', # noqa: E501 - 'seasonal': 'seasonal', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, confidence_level, forecast_period, seasonal, *args, **kwargs): # noqa: E501 - """ForecastConfig - a model defined in OpenAPI - - Args: - confidence_level (float): Confidence interval boundary value. - forecast_period (int): Number of future periods that should be forecasted - seasonal (bool): Whether the input data is seasonal - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.confidence_level = confidence_level - self.forecast_period = forecast_period - self.seasonal = seasonal - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, confidence_level, forecast_period, seasonal, *args, **kwargs): # noqa: E501 - """ForecastConfig - a model defined in OpenAPI - - Args: - confidence_level (float): Confidence interval boundary value. - forecast_period (int): Number of future periods that should be forecasted - seasonal (bool): Whether the input data is seasonal - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.confidence_level = confidence_level - self.forecast_period = forecast_period - self.seasonal = seasonal - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/get_ai_lake_operation200_response.py b/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py index 279d56d06..1a84a2f41 100644 --- a/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py +++ b/gooddata-api-client/gooddata_api_client/model/get_ai_lake_operation200_response.py @@ -70,10 +70,7 @@ class GetAiLakeOperation200Response(ModelComposed): 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", - 'CREATE-PIPE-TABLE': "create-pipe-table", - 'DELETE-PIPE-TABLE': "delete-pipe-table", 'ANALYZE-STATISTICS': "analyze-statistics", - 'REFRESH-PARTITION': "refresh-partition", }, } @@ -175,7 +172,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) result ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Operation-specific result payload, can be missing for operations like delete. [optional] # noqa: E501 id (str): Id of the operation. [optional] # noqa: E501 - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). . [optional] # noqa: E501 + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. . [optional] # noqa: E501 error (OperationError): [optional] # noqa: E501 """ @@ -283,7 +280,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) result ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Operation-specific result payload, can be missing for operations like delete. [optional] # noqa: E501 id (str): Id of the operation. [optional] # noqa: E501 - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). . [optional] # noqa: E501 + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. . [optional] # noqa: E501 error (OperationError): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/granted_permission.py b/gooddata-api-client/gooddata_api_client/model/granted_permission.py index 21ce103d1..aaa63e301 100644 --- a/gooddata-api-client/gooddata_api_client/model/granted_permission.py +++ b/gooddata-api-client/gooddata_api_client/model/granted_permission.py @@ -56,6 +56,10 @@ class GrantedPermission(ModelNormal): """ allowed_values = { + ('source',): { + 'DIRECT': "direct", + 'INDIRECT': "indirect", + }, } validations = { 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 953a6b5ce..6126167df 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 @@ -66,6 +66,7 @@ class IdentifierRefIdentifier(ModelNormal): 'AGGREGATEDFACT': "aggregatedFact", 'LABEL': "label", 'METRIC': "metric", + 'COMPUTEDATTRIBUTE': "computedAttribute", 'USERDATAFILTER': "userDataFilter", 'PARAMETER': "parameter", 'EXPORTDEFINITION': "exportDefinition", @@ -81,6 +82,9 @@ class IdentifierRefIdentifier(ModelNormal): 'WORKSPACEDATAFILTER': "workspaceDataFilter", 'WORKSPACEDATAFILTERSETTING': "workspaceDataFilterSetting", 'FILTERVIEW': "filterView", + 'REPORTPAGELAYOUT': "reportPageLayout", + 'REPORTTEMPLATE': "reportTemplate", + 'REPORT': "report", 'WORKSPACEEXPORTTEMPLATE': "workspaceExportTemplate", 'WORKSPACETHEME': "workspaceTheme", 'WORKSPACECOLORPALETTE': "workspaceColorPalette", diff --git a/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py deleted file mode 100644 index 2c0d5ee7f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/insight_widget_descriptor.py +++ /dev/null @@ -1,307 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.filter_definition import FilterDefinition - globals()['FilterDefinition'] = FilterDefinition - - -class InsightWidgetDescriptor(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 = { - ('widget_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 - """ - 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 { - 'title': (str,), # noqa: E501 - 'visualization_id': (str,), # noqa: E501 - 'widget_id': (str,), # noqa: E501 - 'widget_type': (str,), # noqa: E501 - 'filters': ([FilterDefinition],), # noqa: E501 - 'result_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'title': 'title', # noqa: E501 - 'visualization_id': 'visualizationId', # noqa: E501 - 'widget_id': 'widgetId', # noqa: E501 - 'widget_type': 'widgetType', # noqa: E501 - 'filters': 'filters', # noqa: E501 - 'result_id': 'resultId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, title, visualization_id, widget_id, *args, **kwargs): # noqa: E501 - """InsightWidgetDescriptor - a model defined in OpenAPI - - Args: - title (str): Widget title as displayed on the dashboard. - visualization_id (str): Visualization object ID referenced by this insight widget. - widget_id (str): Widget object ID. - - Keyword Args: - widget_type (str): defaults to "insight", must be one of ["insight", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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 ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 - result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 - """ - - widget_type = kwargs.get('widget_type', "insight") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - self.visualization_id = visualization_id - self.widget_id = widget_id - self.widget_type = widget_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - 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, title, visualization_id, widget_id, *args, **kwargs): # noqa: E501 - """InsightWidgetDescriptor - a model defined in OpenAPI - - Args: - title (str): Widget title as displayed on the dashboard. - visualization_id (str): Visualization object ID referenced by this insight widget. - widget_id (str): Widget object ID. - - Keyword Args: - widget_type (str): defaults to "insight", must be one of ["insight", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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 ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 - result_id (str): Signed result ID for this widget's cached execution result.. [optional] # noqa: E501 - """ - - widget_type = kwargs.get('widget_type', "insight") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.title = title - self.visualization_id = visualization_id - self.widget_id = widget_id - self.widget_type = widget_type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - 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/instruction.py b/gooddata-api-client/gooddata_api_client/model/instruction.py new file mode 100644 index 000000000..0eeeb279b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/instruction.py @@ -0,0 +1,294 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class Instruction(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('strategy',): { + 'ALWAYS': "ALWAYS", + 'AUTO': "AUTO", + }, + } + + validations = { + ('content',): { + 'max_length': 255, + }, + ('title',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = 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 { + 'content': (str,), # noqa: E501 + 'strategy': (str,), # noqa: E501 + 'is_disabled': (bool, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'strategy': 'strategy', # noqa: E501 + 'is_disabled': 'isDisabled', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, strategy, *args, **kwargs): # noqa: E501 + """Instruction - a model defined in OpenAPI + + Args: + content (str): The rule the agent follows when answering + strategy (str): When an instruction is applied to a request + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + is_disabled (bool, none_type): Whether the instruction is disabled. [optional] # noqa: E501 + title (str, none_type): Short name shown in the agent builder.. [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.strategy = strategy + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, content, strategy, *args, **kwargs): # noqa: E501 + """Instruction - a model defined in OpenAPI + + Args: + content (str): The rule the agent follows when answering + strategy (str): When an instruction is applied to a request + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + is_disabled (bool, none_type): Whether the instruction is disabled. [optional] # noqa: E501 + title (str, none_type): Short name shown in the agent builder.. [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.strategy = strategy + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/refresh_partition_request.py b/gooddata-api-client/gooddata_api_client/model/invitation.py similarity index 87% rename from gooddata-api-client/gooddata_api_client/model/refresh_partition_request.py rename to gooddata-api-client/gooddata_api_client/model/invitation.py index 18ec864d9..85137cf75 100644 --- a/gooddata-api-client/gooddata_api_client/model/refresh_partition_request.py +++ b/gooddata-api-client/gooddata_api_client/model/invitation.py @@ -31,7 +31,7 @@ -class RefreshPartitionRequest(ModelNormal): +class Invitation(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -82,7 +82,11 @@ def openapi_types(): and the value is attribute type. """ return { - 'partition_spec': ({str: (str,)},), # noqa: E501 + 'email': (str,), # noqa: E501 + 'user_id': (str,), # noqa: E501 + 'first_name': (str,), # noqa: E501 + 'force_send': (bool,), # noqa: E501 + 'last_name': (str,), # noqa: E501 } @cached_property @@ -91,7 +95,11 @@ def discriminator(): attribute_map = { - 'partition_spec': 'partitionSpec', # noqa: E501 + 'email': 'email', # noqa: E501 + 'user_id': 'userId', # noqa: E501 + 'first_name': 'firstName', # noqa: E501 + 'force_send': 'forceSend', # noqa: E501 + 'last_name': 'lastName', # noqa: E501 } read_only_vars = { @@ -101,11 +109,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, partition_spec, *args, **kwargs): # noqa: E501 - """RefreshPartitionRequest - a model defined in OpenAPI + def _from_openapi_data(cls, email, user_id, *args, **kwargs): # noqa: E501 + """Invitation - a model defined in OpenAPI Args: - partition_spec ({str: (str,)}): Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"} + email (str): + user_id (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -138,6 +147,9 @@ def _from_openapi_data(cls, partition_spec, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + first_name (str): [optional] # noqa: E501 + force_send (bool): Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends). [optional] # noqa: E501 + last_name (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -169,7 +181,8 @@ def _from_openapi_data(cls, partition_spec, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.partition_spec = partition_spec + self.email = email + self.user_id = user_id for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -190,11 +203,12 @@ def _from_openapi_data(cls, partition_spec, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, partition_spec, *args, **kwargs): # noqa: E501 - """RefreshPartitionRequest - a model defined in OpenAPI + def __init__(self, email, user_id, *args, **kwargs): # noqa: E501 + """Invitation - a model defined in OpenAPI Args: - partition_spec ({str: (str,)}): Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"} + email (str): + user_id (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -227,6 +241,9 @@ def __init__(self, partition_spec, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + first_name (str): [optional] # noqa: E501 + force_send (bool): Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends). [optional] # noqa: E501 + last_name (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -256,7 +273,8 @@ def __init__(self, partition_spec, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.partition_spec = partition_spec + self.email = email + self.user_id = user_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/json_api_agent_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes.py index fea2c0140..9251d4dfc 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 @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_agent_in_attributes_instructions_inner import JsonApiAgentInAttributesInstructionsInner + globals()['JsonApiAgentInAttributesInstructionsInner'] = JsonApiAgentInAttributesInstructionsInner + class JsonApiAgentInAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -70,6 +74,9 @@ class JsonApiAgentInAttributes(ModelNormal): 'DASHBOARD_SUMMARY': "dashboard_summary", 'WHAT_IF_ANALYSIS': "what_if_analysis", 'KNOWLEDGE': "knowledge", + 'DASHBOARD_BUILDER': "dashboard_builder", + 'DASHBOARD_EDITOR': "dashboard_editor", + 'REPORT_BUILDER': "report_builder", }, ('skills_mode',): { 'ALL': "all", @@ -95,6 +102,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -109,12 +117,14 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'ai_knowledge': (bool,), # noqa: E501 'available_to_all': (bool,), # noqa: E501 'custom_skills': ([str], none_type,), # noqa: E501 'description': (str, none_type,), # noqa: E501 'enabled': (bool,), # noqa: E501 + 'instructions': ([JsonApiAgentInAttributesInstructionsInner], none_type,), # noqa: E501 'is_preview': (bool,), # noqa: E501 'name': (str, none_type,), # noqa: E501 'personality': (str, none_type,), # noqa: E501 @@ -132,6 +142,7 @@ def discriminator(): 'custom_skills': 'customSkills', # noqa: E501 'description': 'description', # noqa: E501 'enabled': 'enabled', # noqa: E501 + 'instructions': 'instructions', # noqa: E501 'is_preview': 'isPreview', # noqa: E501 'name': 'name', # noqa: E501 'personality': 'personality', # noqa: E501 @@ -184,6 +195,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 custom_skills ([str], none_type): [optional] # noqa: E501 description (str, none_type): [optional] # noqa: E501 enabled (bool): [optional] # noqa: E501 + instructions ([JsonApiAgentInAttributesInstructionsInner], none_type): Rules this agent follows when answering.. [optional] # noqa: E501 is_preview (bool): [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 personality (str, none_type): [optional] # noqa: E501 @@ -278,6 +290,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 custom_skills ([str], none_type): [optional] # noqa: E501 description (str, none_type): [optional] # noqa: E501 enabled (bool): [optional] # noqa: E501 + instructions ([JsonApiAgentInAttributesInstructionsInner], none_type): Rules this agent follows when answering.. [optional] # noqa: E501 is_preview (bool): [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 personality (str, none_type): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes_instructions_inner.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes_instructions_inner.py new file mode 100644 index 000000000..a8bb995de --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_agent_in_attributes_instructions_inner.py @@ -0,0 +1,294 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiAgentInAttributesInstructionsInner(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('strategy',): { + 'ALWAYS': "ALWAYS", + 'AUTO': "AUTO", + }, + } + + validations = { + ('content',): { + 'max_length': 255, + }, + ('title',): { + 'max_length': 255, + }, + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'content': (str,), # noqa: E501 + 'strategy': (str,), # noqa: E501 + 'is_disabled': (bool, none_type,), # noqa: E501 + 'title': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'strategy': 'strategy', # noqa: E501 + 'is_disabled': 'isDisabled', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, strategy, *args, **kwargs): # noqa: E501 + """JsonApiAgentInAttributesInstructionsInner - a model defined in OpenAPI + + Args: + content (str): The rule the agent follows when answering + strategy (str): When an instruction is applied to a request + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + is_disabled (bool, none_type): Whether the instruction is disabled. [optional] # noqa: E501 + title (str, none_type): Short name shown in the agent builder.. [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.strategy = strategy + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, content, strategy, *args, **kwargs): # noqa: E501 + """JsonApiAgentInAttributesInstructionsInner - a model defined in OpenAPI + + Args: + content (str): The rule the agent follows when answering + strategy (str): When an instruction is applied to a request + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + is_disabled (bool, none_type): Whether the instruction is disabled. [optional] # noqa: E501 + title (str, none_type): Short name shown in the agent builder.. [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.strategy = strategy + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_attributes.py index 476b81179..314cb5738 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 @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_agent_in_attributes_instructions_inner import JsonApiAgentInAttributesInstructionsInner + globals()['JsonApiAgentInAttributesInstructionsInner'] = JsonApiAgentInAttributesInstructionsInner + class JsonApiAgentOutAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -70,6 +74,9 @@ class JsonApiAgentOutAttributes(ModelNormal): 'DASHBOARD_SUMMARY': "dashboard_summary", 'WHAT_IF_ANALYSIS': "what_if_analysis", 'KNOWLEDGE': "knowledge", + 'DASHBOARD_BUILDER': "dashboard_builder", + 'DASHBOARD_EDITOR': "dashboard_editor", + 'REPORT_BUILDER': "report_builder", }, ('skills_mode',): { 'ALL': "all", @@ -95,6 +102,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -109,6 +117,7 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'ai_knowledge': (bool,), # noqa: E501 'available_to_all': (bool,), # noqa: E501 @@ -116,6 +125,7 @@ def openapi_types(): 'custom_skills': ([str], none_type,), # noqa: E501 'description': (str, none_type,), # noqa: E501 'enabled': (bool,), # noqa: E501 + 'instructions': ([JsonApiAgentInAttributesInstructionsInner], none_type,), # noqa: E501 'is_preview': (bool,), # noqa: E501 'modified_at': (datetime,), # noqa: E501 'name': (str, none_type,), # noqa: E501 @@ -135,6 +145,7 @@ def discriminator(): 'custom_skills': 'customSkills', # noqa: E501 'description': 'description', # noqa: E501 'enabled': 'enabled', # noqa: E501 + 'instructions': 'instructions', # noqa: E501 'is_preview': 'isPreview', # noqa: E501 'modified_at': 'modifiedAt', # noqa: E501 'name': 'name', # noqa: E501 @@ -189,6 +200,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 custom_skills ([str], none_type): [optional] # noqa: E501 description (str, none_type): [optional] # noqa: E501 enabled (bool): [optional] # noqa: E501 + instructions ([JsonApiAgentInAttributesInstructionsInner], none_type): Rules this agent follows when answering.. [optional] # noqa: E501 is_preview (bool): [optional] # noqa: E501 modified_at (datetime): [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 @@ -285,6 +297,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 custom_skills ([str], none_type): [optional] # noqa: E501 description (str, none_type): [optional] # noqa: E501 enabled (bool): [optional] # noqa: E501 + instructions ([JsonApiAgentInAttributesInstructionsInner], none_type): Rules this agent follows when answering.. [optional] # noqa: E501 is_preview (bool): [optional] # noqa: E501 modified_at (datetime): [optional] # noqa: E501 name (str, none_type): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document.py index c886e45ab..47411958d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document.py @@ -32,9 +32,11 @@ def lazy_import(): from gooddata_api_client.model.json_api_agent_out import JsonApiAgentOut + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_agent_out_includes import JsonApiAgentOutIncludes from gooddata_api_client.model.object_links import ObjectLinks globals()['JsonApiAgentOut'] = JsonApiAgentOut + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAgentOutIncludes'] = JsonApiAgentOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiAgentOut,), # noqa: E501 'included': ([JsonApiAgentOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAgentOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAgentOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document_meta.py new file mode 100644 index 000000000..c80a4d552 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_document_meta.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 + + +def lazy_import(): + from gooddata_api_client.model.restricted_object import RestrictedObject + globals()['RestrictedObject'] = RestrictedObject + + +class JsonApiAgentOutDocumentMeta(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 = { + ('restricted',): { + }, + } + + @cached_property + def additional_properties_type(): + """ + 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 { + 'restricted': ([RestrictedObject],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'restricted': 'restricted', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiAgentOutDocumentMeta - 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,) + restricted ([RestrictedObject]): 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.. [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 + """JsonApiAgentOutDocumentMeta - 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,) + restricted ([RestrictedObject]): 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.. [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_agent_out_list_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_list_meta.py index 49060ec4b..603446700 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_list_meta.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_agent_out_list_meta.py @@ -32,7 +32,9 @@ def lazy_import(): from gooddata_api_client.model.page_metadata import PageMetadata + from gooddata_api_client.model.restricted_object import RestrictedObject globals()['PageMetadata'] = PageMetadata + globals()['RestrictedObject'] = RestrictedObject class JsonApiAgentOutListMeta(ModelNormal): @@ -63,6 +65,8 @@ class JsonApiAgentOutListMeta(ModelNormal): } validations = { + ('restricted',): { + }, } @cached_property @@ -89,6 +93,7 @@ def openapi_types(): lazy_import() return { 'page': (PageMetadata,), # noqa: E501 + 'restricted': ([RestrictedObject],), # noqa: E501 } @cached_property @@ -98,6 +103,7 @@ def discriminator(): attribute_map = { 'page': 'page', # noqa: E501 + 'restricted': 'restricted', # noqa: E501 } read_only_vars = { @@ -142,6 +148,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) page (PageMetadata): [optional] # noqa: E501 + restricted ([RestrictedObject]): 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.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -228,6 +235,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) page (PageMetadata): [optional] # noqa: E501 + restricted ([RestrictedObject]): 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.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py index daf47528c..1633f905a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_aggregated_fact_out import JsonApiAggregatedFactOut from gooddata_api_client.model.json_api_aggregated_fact_out_includes import JsonApiAggregatedFactOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAggregatedFactOut'] = JsonApiAggregatedFactOut globals()['JsonApiAggregatedFactOutIncludes'] = JsonApiAggregatedFactOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiAggregatedFactOut,), # noqa: E501 'included': ([JsonApiAggregatedFactOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAggregatedFactOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAggregatedFactOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py index 3a9143860..efdbfb498 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_aggregated_fact_out_includes.py @@ -31,14 +31,14 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks globals()['JsonApiFactOutAttributes'] = JsonApiFactOutAttributes @@ -108,7 +108,7 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiFactOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 'attributes': (JsonApiFactOutAttributes,), # noqa: E501 @@ -169,7 +169,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 @@ -278,7 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py index 014741396..1302a3a99 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_analytical_dashboard_out import JsonApiAnalyticalDashboardOut from gooddata_api_client.model.json_api_analytical_dashboard_out_includes import JsonApiAnalyticalDashboardOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAnalyticalDashboardOut'] = JsonApiAnalyticalDashboardOut globals()['JsonApiAnalyticalDashboardOutIncludes'] = JsonApiAnalyticalDashboardOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiAnalyticalDashboardOut,), # noqa: E501 'included': ([JsonApiAnalyticalDashboardOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAnalyticalDashboardOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAnalyticalDashboardOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py index 5c2e884b4..c27c45694 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_includes.py @@ -31,26 +31,28 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships + from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks from gooddata_api_client.model.json_api_dashboard_plugin_out_with_links import JsonApiDashboardPluginOutWithLinks from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_filter_context_out_with_links import JsonApiFilterContextOutWithLinks from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks from gooddata_api_client.model.json_api_parameter_out_with_links import JsonApiParameterOutWithLinks from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships + globals()['JsonApiComputedAttributeOutWithLinks'] = JsonApiComputedAttributeOutWithLinks globals()['JsonApiDashboardPluginOutWithLinks'] = JsonApiDashboardPluginOutWithLinks globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks globals()['JsonApiFilterContextOutWithLinks'] = JsonApiFilterContextOutWithLinks globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks globals()['JsonApiParameterOutWithLinks'] = JsonApiParameterOutWithLinks globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks @@ -120,8 +122,8 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 @@ -181,8 +183,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiVisualizationObjectOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 @@ -290,8 +292,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiVisualizationObjectOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 @@ -368,6 +370,7 @@ def _composed_schemas(): ], 'oneOf': [ JsonApiAnalyticalDashboardOutWithLinks, + JsonApiComputedAttributeOutWithLinks, JsonApiDashboardPluginOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFilterContextOutWithLinks, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py index 9199a70f1..e9afbfde4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships.py @@ -33,6 +33,7 @@ def lazy_import(): from gooddata_api_client.model.json_api_agent_out_relationships_created_by import JsonApiAgentOutRelationshipsCreatedBy from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_computed_attributes import JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts @@ -42,6 +43,7 @@ def lazy_import(): from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects globals()['JsonApiAgentOutRelationshipsCreatedBy'] = JsonApiAgentOutRelationshipsCreatedBy globals()['JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards'] = JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards + globals()['JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes'] = JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes globals()['JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins'] = JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAnalyticalDashboardOutRelationshipsFilterContexts'] = JsonApiAnalyticalDashboardOutRelationshipsFilterContexts @@ -106,6 +108,7 @@ def openapi_types(): return { 'analytical_dashboards': (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards,), # noqa: E501 'certified_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 + 'computed_attributes': (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes,), # noqa: E501 'created_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 'dashboard_plugins': (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins,), # noqa: E501 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 @@ -125,6 +128,7 @@ def discriminator(): attribute_map = { 'analytical_dashboards': 'analyticalDashboards', # noqa: E501 'certified_by': 'certifiedBy', # noqa: E501 + 'computed_attributes': 'computedAttributes', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'dashboard_plugins': 'dashboardPlugins', # noqa: E501 'datasets': 'datasets', # noqa: E501 @@ -179,6 +183,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 certified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 created_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 dashboard_plugins (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 @@ -275,6 +280,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 certified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 created_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 dashboard_plugins (JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_document_pipe_table.py b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_computed_attributes.py similarity index 92% rename from gooddata-api-client/gooddata_api_client/model/json_api_document_pipe_table.py rename to gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_computed_attributes.py index 93d632e71..275e6cb73 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_document_pipe_table.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_analytical_dashboard_out_relationships_computed_attributes.py @@ -31,13 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_item_pipe_table import JsonApiItemPipeTable - from gooddata_api_client.model.json_api_list_links import JsonApiListLinks - globals()['JsonApiItemPipeTable'] = JsonApiItemPipeTable - globals()['JsonApiListLinks'] = JsonApiListLinks + from gooddata_api_client.model.json_api_computed_attribute_to_many_linkage import JsonApiComputedAttributeToManyLinkage + globals()['JsonApiComputedAttributeToManyLinkage'] = JsonApiComputedAttributeToManyLinkage -class JsonApiDocumentPipeTable(ModelNormal): +class JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -90,8 +88,7 @@ def openapi_types(): """ lazy_import() return { - 'data': (JsonApiItemPipeTable,), # noqa: E501 - 'links': (JsonApiListLinks,), # noqa: E501 + 'data': (JsonApiComputedAttributeToManyLinkage,), # noqa: E501 } @cached_property @@ -101,7 +98,6 @@ def discriminator(): attribute_map = { 'data': 'data', # noqa: E501 - 'links': 'links', # noqa: E501 } read_only_vars = { @@ -111,12 +107,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 - """JsonApiDocumentPipeTable - a model defined in OpenAPI + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes - a model defined in OpenAPI Args: - data (JsonApiItemPipeTable): - links (JsonApiListLinks): + data (JsonApiComputedAttributeToManyLinkage): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -181,7 +176,6 @@ def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.data = data - self.links = links for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -202,12 +196,11 @@ def _from_openapi_data(cls, data, links, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, data, links, *args, **kwargs): # noqa: E501 - """JsonApiDocumentPipeTable - a model defined in OpenAPI + def __init__(self, data, *args, **kwargs): # noqa: E501 + """JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes - a model defined in OpenAPI Args: - data (JsonApiItemPipeTable): - links (JsonApiListLinks): + data (JsonApiComputedAttributeToManyLinkage): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -270,7 +263,6 @@ def __init__(self, data, links, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.data = data - self.links = links for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py index f42b4ad29..64411f6dd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiApiTokenOutWithLinks'] = JsonApiApiTokenOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiApiTokenOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llms.py b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list_meta.py similarity index 95% rename from gooddata-api-client/gooddata_api_client/model/resolved_llms.py rename to gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list_meta.py index 4d0f6f93f..a9c3a9820 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llms.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_api_token_out_list_meta.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.resolved_llms_data import ResolvedLlmsData - globals()['ResolvedLlmsData'] = ResolvedLlmsData + from gooddata_api_client.model.page_metadata import PageMetadata + globals()['PageMetadata'] = PageMetadata -class ResolvedLlms(ModelNormal): +class JsonApiApiTokenOutListMeta(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -88,7 +88,7 @@ def openapi_types(): """ lazy_import() return { - 'data': (ResolvedLlmsData,), # noqa: E501 + 'page': (PageMetadata,), # noqa: E501 } @cached_property @@ -97,7 +97,7 @@ def discriminator(): attribute_map = { - 'data': 'data', # noqa: E501 + 'page': 'page', # noqa: E501 } read_only_vars = { @@ -108,7 +108,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ResolvedLlms - a model defined in OpenAPI + """JsonApiApiTokenOutListMeta - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -141,7 +141,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data (ResolvedLlmsData): [optional] # noqa: E501 + page (PageMetadata): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -194,7 +194,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ResolvedLlms - a model defined in OpenAPI + """JsonApiApiTokenOutListMeta - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -227,7 +227,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - data (ResolvedLlmsData): [optional] # noqa: E501 + page (PageMetadata): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py index 23cddaf93..b32bae5db 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_attribute_hierarchy_out import JsonApiAttributeHierarchyOut from gooddata_api_client.model.json_api_attribute_hierarchy_out_includes import JsonApiAttributeHierarchyOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAttributeHierarchyOut'] = JsonApiAttributeHierarchyOut globals()['JsonApiAttributeHierarchyOutIncludes'] = JsonApiAttributeHierarchyOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiAttributeHierarchyOut,), # noqa: E501 'included': ([JsonApiAttributeHierarchyOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAttributeHierarchyOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAttributeHierarchyOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py index 894a460c8..9db4a2336 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_hierarchy_out_includes.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks from gooddata_api_client.model.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiAttributeOutRelationships'] = JsonApiAttributeOutRelationships globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks globals()['JsonApiUserIdentifierOutAttributes'] = JsonApiUserIdentifierOutAttributes @@ -107,7 +107,7 @@ def openapi_types(): lazy_import() return { 'attributes': (JsonApiUserIdentifierOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 'id': (str,), # noqa: E501 @@ -168,7 +168,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 @@ -277,7 +277,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py index 47ab51f12..ae023860f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAttributeOutAttributes'] = JsonApiAttributeOutAttributes + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiAttributeOutRelationships'] = JsonApiAttributeOutRelationships @@ -103,7 +103,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 'attributes': (JsonApiAttributeOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiAttributeOutRelationships,), # noqa: E501 } @@ -166,7 +166,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 """ @@ -261,7 +261,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py index 047512f34..4c4858c7c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_attribute_out_attributes_conditional_formatting import JsonApiAttributeOutAttributesConditionalFormatting + globals()['JsonApiAttributeOutAttributesConditionalFormatting'] = JsonApiAttributeOutAttributesConditionalFormatting + class JsonApiAttributeOutAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -135,6 +139,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -149,8 +154,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'are_relations_valid': (bool,), # noqa: E501 + 'conditional_formatting': (JsonApiAttributeOutAttributesConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'granularity': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -172,6 +179,7 @@ def discriminator(): attribute_map = { 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'granularity': 'granularity', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -228,6 +236,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiAttributeOutAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 granularity (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -326,6 +335,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiAttributeOutAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 granularity (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes_conditional_formatting.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes_conditional_formatting.py new file mode 100644 index 000000000..f4eeb18e9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_attributes_conditional_formatting.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.conditional_formatting_condition import ConditionalFormattingCondition + globals()['ConditionalFormattingCondition'] = ConditionalFormattingCondition + + +class JsonApiAttributeOutAttributesConditionalFormatting(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 = 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 { + 'conditions': ([ConditionalFormattingCondition],), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'conditions': 'conditions', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, conditions, enabled, *args, **kwargs): # noqa: E501 + """JsonApiAttributeOutAttributesConditionalFormatting - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.conditions = conditions + self.enabled = enabled + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, conditions, enabled, *args, **kwargs): # noqa: E501 + """JsonApiAttributeOutAttributesConditionalFormatting - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.conditions = conditions + self.enabled = enabled + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_attribute_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.py index 4e1f8d66b..3e5fa7d8f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAttributeOut'] = JsonApiAttributeOut globals()['JsonApiAttributeOutIncludes'] = JsonApiAttributeOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiAttributeOut,), # noqa: E501 'included': ([JsonApiAttributeOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py index c9fe644fe..c2f00a8cc 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_includes.py @@ -31,15 +31,15 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_attribute_hierarchy_out_with_links import JsonApiAttributeHierarchyOutWithLinks + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAttributeHierarchyOutWithLinks'] = JsonApiAttributeHierarchyOutWithLinks + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships @@ -108,7 +108,7 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 @@ -169,7 +169,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 @@ -278,7 +278,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_meta.py new file mode 100644 index 000000000..cd32595f2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_meta.py @@ -0,0 +1,279 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_aggregated_fact_out_meta_origin import JsonApiAggregatedFactOutMetaOrigin + globals()['JsonApiAggregatedFactOutMetaOrigin'] = JsonApiAggregatedFactOutMetaOrigin + + +class JsonApiAttributeOutMeta(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + 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 { + 'origin': (JsonApiAggregatedFactOutMetaOrigin,), # noqa: E501 + 'permissions': ([str],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'origin': 'origin', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiAttributeOutMeta - 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,) + origin (JsonApiAggregatedFactOutMetaOrigin): [optional] # noqa: E501 + permissions ([str]): List of valid permissions for a logged-in user.. [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 + """JsonApiAttributeOutMeta - 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,) + origin (JsonApiAggregatedFactOutMetaOrigin): [optional] # noqa: E501 + permissions ([str]): List of valid permissions for a logged-in user.. [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_attribute_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.py index c4b232f26..9777bcc50 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_out_with_links.py @@ -31,15 +31,15 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAttributeOut'] = JsonApiAttributeOut globals()['JsonApiAttributeOutAttributes'] = JsonApiAttributeOutAttributes + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiAttributeOutRelationships'] = JsonApiAttributeOutRelationships globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -109,7 +109,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 'attributes': (JsonApiAttributeOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -170,7 +170,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -280,7 +280,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_attributes.py index 9708622d1..46bce745d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_attribute_patch_attributes.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_attribute_out_attributes_conditional_formatting import JsonApiAttributeOutAttributesConditionalFormatting + globals()['JsonApiAttributeOutAttributesConditionalFormatting'] = JsonApiAttributeOutAttributesConditionalFormatting + class JsonApiAttributePatchAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -73,6 +77,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -87,7 +92,9 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { + 'conditional_formatting': (JsonApiAttributeOutAttributesConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 @@ -99,6 +106,7 @@ def discriminator(): attribute_map = { + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'tags': 'tags', # noqa: E501 'title': 'title', # noqa: E501 @@ -145,6 +153,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (JsonApiAttributeOutAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 @@ -233,6 +242,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (JsonApiAttributeOutAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 title (str): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py index ce4717bd2..2353e5b0f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_in_attributes_alert.py @@ -33,8 +33,10 @@ def lazy_import(): from gooddata_api_client.model.alert_afm import AlertAfm from gooddata_api_client.model.alert_condition import AlertCondition + from gooddata_api_client.model.execution_settings import ExecutionSettings globals()['AlertAfm'] = AlertAfm globals()['AlertCondition'] = AlertCondition + globals()['ExecutionSettings'] = ExecutionSettings class JsonApiAutomationInAttributesAlert(ModelNormal): @@ -105,6 +107,7 @@ def openapi_types(): 'condition': (AlertCondition,), # noqa: E501 'execution': (AlertAfm,), # noqa: E501 'interval': (str,), # noqa: E501 + 'settings': (ExecutionSettings,), # noqa: E501 'trigger': (str,), # noqa: E501 } @@ -117,6 +120,7 @@ def discriminator(): 'condition': 'condition', # noqa: E501 'execution': 'execution', # noqa: E501 'interval': 'interval', # noqa: E501 + 'settings': 'settings', # noqa: E501 'trigger': 'trigger', # noqa: E501 } @@ -166,6 +170,7 @@ def _from_openapi_data(cls, condition, execution, *args, **kwargs): # noqa: E50 through its discriminator because we passed in _visited_composed_classes = (Animal,) interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ @@ -259,6 +264,7 @@ def __init__(self, condition, execution, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) interval (str): Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.. [optional] # noqa: E501 + settings (ExecutionSettings): [optional] # noqa: E501 trigger (str): Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met. ONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS. . [optional] if omitted the server will use the default value of "ALWAYS" # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py index 3d43e8688..67e98912a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_automation_out import JsonApiAutomationOut from gooddata_api_client.model.json_api_automation_out_includes import JsonApiAutomationOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAutomationOut'] = JsonApiAutomationOut globals()['JsonApiAutomationOutIncludes'] = JsonApiAutomationOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiAutomationOut,), # noqa: E501 'included': ([JsonApiAutomationOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAutomationOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py index 6fe12bb99..5a2da5c6b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_includes.py @@ -31,25 +31,37 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_in_relationships import JsonApiAgentInRelationships - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks from gooddata_api_client.model.json_api_automation_result_out_with_links import JsonApiAutomationResultOutWithLinks + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships + from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks from gooddata_api_client.model.json_api_export_definition_out_with_links import JsonApiExportDefinitionOutWithLinks + from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks + from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks + from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks - from gooddata_api_client.model.json_api_user_identifier_out_attributes import JsonApiUserIdentifierOutAttributes from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks from gooddata_api_client.model.json_api_user_out_with_links import JsonApiUserOutWithLinks + from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes + from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAgentInRelationships'] = JsonApiAgentInRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks globals()['JsonApiAutomationResultOutWithLinks'] = JsonApiAutomationResultOutWithLinks + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships + globals()['JsonApiComputedAttributeOutWithLinks'] = JsonApiComputedAttributeOutWithLinks globals()['JsonApiExportDefinitionOutWithLinks'] = JsonApiExportDefinitionOutWithLinks + globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks + globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks + globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks globals()['JsonApiNotificationChannelOutWithLinks'] = JsonApiNotificationChannelOutWithLinks - globals()['JsonApiUserIdentifierOutAttributes'] = JsonApiUserIdentifierOutAttributes globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['JsonApiUserOutWithLinks'] = JsonApiUserOutWithLinks + globals()['JsonApiVisualizationObjectOutAttributes'] = JsonApiVisualizationObjectOutAttributes + globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -79,7 +91,7 @@ class JsonApiAutomationOutIncludes(ModelComposed): allowed_values = { ('type',): { - 'USERIDENTIFIER': "userIdentifier", + 'VISUALIZATIONOBJECT': "visualizationObject", }, } @@ -114,10 +126,10 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiAgentInRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiUserIdentifierOutAttributes,), # noqa: E501 + 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -175,12 +187,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAgentInRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 + attributes (JsonApiVisualizationObjectOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "userIdentifier" # noqa: E501 + type (str): Object type. [optional] if omitted the server will use the default value of "visualizationObject" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -284,12 +296,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiAgentInRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiUserIdentifierOutAttributes): [optional] # noqa: E501 + attributes (JsonApiVisualizationObjectOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "userIdentifier" # noqa: E501 + type (str): Object type. [optional] if omitted the server will use the default value of "visualizationObject" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -362,10 +374,16 @@ def _composed_schemas(): ], 'oneOf': [ JsonApiAnalyticalDashboardOutWithLinks, + JsonApiAttributeOutWithLinks, JsonApiAutomationResultOutWithLinks, + JsonApiComputedAttributeOutWithLinks, JsonApiExportDefinitionOutWithLinks, + JsonApiFactOutWithLinks, + JsonApiLabelOutWithLinks, + JsonApiMetricOutWithLinks, JsonApiNotificationChannelOutWithLinks, JsonApiUserIdentifierOutWithLinks, JsonApiUserOutWithLinks, + JsonApiVisualizationObjectOutWithLinks, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py index eb55370e2..618b4797b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships.py @@ -32,17 +32,31 @@ def lazy_import(): from gooddata_api_client.model.json_api_agent_out_relationships_created_by import JsonApiAgentOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_computed_attributes import JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_visualization_objects import JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects + from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes from gooddata_api_client.model.json_api_automation_in_relationships_analytical_dashboard import JsonApiAutomationInRelationshipsAnalyticalDashboard from gooddata_api_client.model.json_api_automation_in_relationships_export_definitions import JsonApiAutomationInRelationshipsExportDefinitions from gooddata_api_client.model.json_api_automation_in_relationships_notification_channel import JsonApiAutomationInRelationshipsNotificationChannel from gooddata_api_client.model.json_api_automation_in_relationships_recipients import JsonApiAutomationInRelationshipsRecipients from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults + from gooddata_api_client.model.json_api_automation_out_relationships_facts import JsonApiAutomationOutRelationshipsFacts globals()['JsonApiAgentOutRelationshipsCreatedBy'] = JsonApiAgentOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards'] = JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards + globals()['JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes'] = JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes + globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels + globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics + globals()['JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects'] = JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects + globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes globals()['JsonApiAutomationInRelationshipsAnalyticalDashboard'] = JsonApiAutomationInRelationshipsAnalyticalDashboard globals()['JsonApiAutomationInRelationshipsExportDefinitions'] = JsonApiAutomationInRelationshipsExportDefinitions globals()['JsonApiAutomationInRelationshipsNotificationChannel'] = JsonApiAutomationInRelationshipsNotificationChannel globals()['JsonApiAutomationInRelationshipsRecipients'] = JsonApiAutomationInRelationshipsRecipients globals()['JsonApiAutomationOutRelationshipsAutomationResults'] = JsonApiAutomationOutRelationshipsAutomationResults + globals()['JsonApiAutomationOutRelationshipsFacts'] = JsonApiAutomationOutRelationshipsFacts class JsonApiAutomationOutRelationships(ModelNormal): @@ -99,12 +113,19 @@ def openapi_types(): lazy_import() return { 'analytical_dashboard': (JsonApiAutomationInRelationshipsAnalyticalDashboard,), # noqa: E501 + 'analytical_dashboards': (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards,), # noqa: E501 + 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 'automation_results': (JsonApiAutomationOutRelationshipsAutomationResults,), # noqa: E501 + 'computed_attributes': (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes,), # noqa: E501 'created_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 'export_definitions': (JsonApiAutomationInRelationshipsExportDefinitions,), # noqa: E501 + 'facts': (JsonApiAutomationOutRelationshipsFacts,), # noqa: E501 + 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 + 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 'modified_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 'notification_channel': (JsonApiAutomationInRelationshipsNotificationChannel,), # noqa: E501 'recipients': (JsonApiAutomationInRelationshipsRecipients,), # noqa: E501 + 'visualization_objects': (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects,), # noqa: E501 } @cached_property @@ -114,12 +135,19 @@ def discriminator(): attribute_map = { 'analytical_dashboard': 'analyticalDashboard', # noqa: E501 + 'analytical_dashboards': 'analyticalDashboards', # noqa: E501 + 'attributes': 'attributes', # noqa: E501 'automation_results': 'automationResults', # noqa: E501 + 'computed_attributes': 'computedAttributes', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'export_definitions': 'exportDefinitions', # noqa: E501 + 'facts': 'facts', # noqa: E501 + 'labels': 'labels', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 'modified_by': 'modifiedBy', # noqa: E501 'notification_channel': 'notificationChannel', # noqa: E501 'recipients': 'recipients', # noqa: E501 + 'visualization_objects': 'visualizationObjects', # noqa: E501 } read_only_vars = { @@ -164,12 +192,19 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 + analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 + attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 created_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 + labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 + metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 modified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 + visualization_objects (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -256,12 +291,19 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) analytical_dashboard (JsonApiAutomationInRelationshipsAnalyticalDashboard): [optional] # noqa: E501 + analytical_dashboards (JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards): [optional] # noqa: E501 + attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 automation_results (JsonApiAutomationOutRelationshipsAutomationResults): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 created_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 export_definitions (JsonApiAutomationInRelationshipsExportDefinitions): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 + labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 + metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 modified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 notification_channel (JsonApiAutomationInRelationshipsNotificationChannel): [optional] # noqa: E501 recipients (JsonApiAutomationInRelationshipsRecipients): [optional] # noqa: E501 + visualization_objects (JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_facts.py b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_facts.py similarity index 98% rename from gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_facts.py rename to gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_facts.py index 43b39cda2..d421cd5e0 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships_facts.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_automation_out_relationships_facts.py @@ -35,7 +35,7 @@ def lazy_import(): globals()['JsonApiFactToManyLinkage'] = JsonApiFactToManyLinkage -class JsonApiDatasetOutRelationshipsFacts(ModelNormal): +class JsonApiAutomationOutRelationshipsFacts(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -108,7 +108,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsFacts - a model defined in OpenAPI + """JsonApiAutomationOutRelationshipsFacts - a model defined in OpenAPI Args: data (JsonApiFactToManyLinkage): @@ -197,7 +197,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, data, *args, **kwargs): # noqa: E501 - """JsonApiDatasetOutRelationshipsFacts - a model defined in OpenAPI + """JsonApiAutomationOutRelationshipsFacts - a model defined in OpenAPI Args: data (JsonApiFactToManyLinkage): diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py index 22e72f90e..27e0cdc22 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_color_palette_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_color_palette_out_with_links import JsonApiColorPaletteOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiColorPaletteOutWithLinks'] = JsonApiColorPaletteOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiColorPaletteOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in.py new file mode 100644 index 000000000..7cef1eb56 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_in_attributes import JsonApiComputedAttributeInAttributes + globals()['JsonApiComputedAttributeInAttributes'] = JsonApiComputedAttributeInAttributes + + +class JsonApiComputedAttributeIn(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',): { + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, + } + + 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': (JsonApiComputedAttributeInAttributes,), # 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 + """JsonApiComputedAttributeIn - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributeInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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', "computedAttribute") + _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 + """JsonApiComputedAttributeIn - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributeInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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', "computedAttribute") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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/visualization_switcher_widget_descriptor.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_attributes.py similarity index 75% rename from gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_attributes.py index 359a5b10f..41571aa70 100644 --- a/gooddata-api-client/gooddata_api_client/model/visualization_switcher_widget_descriptor.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_attributes.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.filter_definition import FilterDefinition - globals()['FilterDefinition'] = FilterDefinition + from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent + globals()['JsonApiComputedAttributeInAttributesContent'] = JsonApiComputedAttributeInAttributesContent -class VisualizationSwitcherWidgetDescriptor(ModelNormal): +class JsonApiComputedAttributeInAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -60,12 +60,36 @@ class VisualizationSwitcherWidgetDescriptor(ModelNormal): """ allowed_values = { - ('widget_type',): { - 'VISUALIZATIONSWITCHER': "visualizationSwitcher", + ('data_type',): { + 'INT': "INT", + 'STRING': "STRING", + 'DATE': "DATE", + 'NUMERIC': "NUMERIC", + 'TIMESTAMP': "TIMESTAMP", + 'TIMESTAMP_TZ': "TIMESTAMP_TZ", + 'BOOLEAN': "BOOLEAN", + 'HLL': "HLL", + }, + ('value_type',): { + 'TEXT': "TEXT", + 'HYPERLINK': "HYPERLINK", + 'GEO': "GEO", + 'GEO_LONGITUDE': "GEO_LONGITUDE", + 'GEO_LATITUDE': "GEO_LATITUDE", + 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", + 'IMAGE': "IMAGE", + 'HYPERLOGLOG': "HYPERLOGLOG", }, } validations = { + ('description',): { + 'max_length': 10000, + }, + ('title',): { + 'max_length': 255, + }, } @cached_property @@ -91,13 +115,17 @@ def openapi_types(): """ lazy_import() return { - 'active_visualization_id': (str,), # noqa: E501 + 'content': (JsonApiComputedAttributeInAttributesContent,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'data_type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'is_hidden': (bool,), # noqa: E501 + 'is_nullable': (bool,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'null_value': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 'title': (str,), # noqa: E501 - 'visualization_ids': ([str],), # noqa: E501 - 'widget_id': (str,), # noqa: E501 - 'widget_type': (str,), # noqa: E501 - 'filters': ([FilterDefinition],), # noqa: E501 - 'result_id': (str,), # noqa: E501 + 'value_type': (str,), # noqa: E501 } @cached_property @@ -106,13 +134,17 @@ def discriminator(): attribute_map = { - 'active_visualization_id': 'activeVisualizationId', # noqa: E501 + 'content': 'content', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'data_type': 'dataType', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_hidden': 'isHidden', # noqa: E501 + 'is_nullable': 'isNullable', # noqa: E501 + 'locale': 'locale', # noqa: E501 + 'null_value': 'nullValue', # noqa: E501 + 'tags': 'tags', # noqa: E501 'title': 'title', # noqa: E501 - 'visualization_ids': 'visualizationIds', # noqa: E501 - 'widget_id': 'widgetId', # noqa: E501 - 'widget_type': 'widgetType', # noqa: E501 - 'filters': 'filters', # noqa: E501 - 'result_id': 'resultId', # noqa: E501 + 'value_type': 'valueType', # noqa: E501 } read_only_vars = { @@ -122,17 +154,13 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, widget_id, *args, **kwargs): # noqa: E501 - """VisualizationSwitcherWidgetDescriptor - a model defined in OpenAPI + def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeInAttributes - a model defined in OpenAPI Args: - active_visualization_id (str): ID of the currently active visualization in the switcher. - title (str): Widget title as displayed on the dashboard. - visualization_ids ([str]): IDs of all visualizations available in the switcher. - widget_id (str): Widget object ID. + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: - widget_type (str): defaults to "visualizationSwitcher", must be one of ["visualizationSwitcher", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -163,11 +191,18 @@ def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, w Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - filters ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 - result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_hidden (bool): [optional] # noqa: E501 + is_nullable (bool): [optional] # noqa: E501 + locale (str): [optional] # noqa: E501 + null_value (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 """ - widget_type = kwargs.get('widget_type', "visualizationSwitcher") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -197,11 +232,7 @@ def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, w self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.active_visualization_id = active_visualization_id - self.title = title - self.visualization_ids = visualization_ids - self.widget_id = widget_id - self.widget_type = widget_type + self.content = content for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -222,17 +253,13 @@ def _from_openapi_data(cls, active_visualization_id, title, visualization_ids, w ]) @convert_js_args_to_python_args - def __init__(self, active_visualization_id, title, visualization_ids, widget_id, *args, **kwargs): # noqa: E501 - """VisualizationSwitcherWidgetDescriptor - a model defined in OpenAPI + def __init__(self, content, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeInAttributes - a model defined in OpenAPI Args: - active_visualization_id (str): ID of the currently active visualization in the switcher. - title (str): Widget title as displayed on the dashboard. - visualization_ids ([str]): IDs of all visualizations available in the switcher. - widget_id (str): Widget object ID. + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: - widget_type (str): defaults to "visualizationSwitcher", must be one of ["visualizationSwitcher", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -263,11 +290,18 @@ def __init__(self, active_visualization_id, title, visualization_ids, widget_id, Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - filters ([FilterDefinition]): Filters currently applied to the dashboard.. [optional] # noqa: E501 - result_id (str): Signed result ID for the currently active visualization's execution result.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_hidden (bool): [optional] # noqa: E501 + is_nullable (bool): [optional] # noqa: E501 + locale (str): [optional] # noqa: E501 + null_value (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 """ - widget_type = kwargs.get('widget_type', "visualizationSwitcher") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -295,11 +329,7 @@ def __init__(self, active_visualization_id, title, visualization_ids, widget_id, self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.active_visualization_id = active_visualization_id - self.title = title - self.visualization_ids = visualization_ids - self.widget_id = widget_id - self.widget_type = widget_type + self.content = content 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/what_if_measure_adjustment_config.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_attributes_content.py similarity index 83% rename from gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_attributes_content.py index 71ab7791e..5306c24e5 100644 --- a/gooddata-api-client/gooddata_api_client/model/what_if_measure_adjustment_config.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_attributes_content.py @@ -31,7 +31,7 @@ -class WhatIfMeasureAdjustmentConfig(ModelNormal): +class JsonApiComputedAttributeInAttributesContent(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,9 +56,19 @@ class WhatIfMeasureAdjustmentConfig(ModelNormal): """ allowed_values = { + ('metric_type',): { + 'UNSPECIFIED': "UNSPECIFIED", + 'CURRENCY': "CURRENCY", + }, } validations = { + ('maql',): { + 'max_length': 10000, + }, + ('format',): { + 'max_length': 2048, + }, } @cached_property @@ -82,9 +92,9 @@ def openapi_types(): and the value is attribute type. """ return { - 'metric_id': (str,), # noqa: E501 + 'maql': (str,), # noqa: E501 + 'format': (str, none_type,), # noqa: E501 'metric_type': (str,), # noqa: E501 - 'scenario_maql': (str,), # noqa: E501 } @cached_property @@ -93,9 +103,9 @@ def discriminator(): attribute_map = { - 'metric_id': 'metricId', # noqa: E501 + 'maql': 'maql', # noqa: E501 + 'format': 'format', # noqa: E501 'metric_type': 'metricType', # noqa: E501 - 'scenario_maql': 'scenarioMaql', # noqa: E501 } read_only_vars = { @@ -105,13 +115,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, metric_id, metric_type, scenario_maql, *args, **kwargs): # noqa: E501 - """WhatIfMeasureAdjustmentConfig - a model defined in OpenAPI + def _from_openapi_data(cls, maql, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeInAttributesContent - a model defined in OpenAPI Args: - metric_id (str): ID of the metric or fact to adjust - metric_type (str): Type: metric or fact - scenario_maql (str): Alternative MAQL expression for this scenario + maql (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -144,6 +152,8 @@ def _from_openapi_data(cls, metric_id, metric_type, scenario_maql, *args, **kwar Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + format (str, none_type): Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.. [optional] # noqa: E501 + metric_type (str): Categorizes metric semantics (e.g., currency).. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -175,9 +185,7 @@ def _from_openapi_data(cls, metric_id, metric_type, scenario_maql, *args, **kwar self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.metric_id = metric_id - self.metric_type = metric_type - self.scenario_maql = scenario_maql + self.maql = maql for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,13 +206,11 @@ def _from_openapi_data(cls, metric_id, metric_type, scenario_maql, *args, **kwar ]) @convert_js_args_to_python_args - def __init__(self, metric_id, metric_type, scenario_maql, *args, **kwargs): # noqa: E501 - """WhatIfMeasureAdjustmentConfig - a model defined in OpenAPI + def __init__(self, maql, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeInAttributesContent - a model defined in OpenAPI Args: - metric_id (str): ID of the metric or fact to adjust - metric_type (str): Type: metric or fact - scenario_maql (str): Alternative MAQL expression for this scenario + maql (str): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -237,6 +243,8 @@ def __init__(self, metric_id, metric_type, scenario_maql, *args, **kwargs): # n Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + format (str, none_type): Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.. [optional] # noqa: E501 + metric_type (str): Categorizes metric semantics (e.g., currency).. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -266,9 +274,7 @@ def __init__(self, metric_id, metric_type, scenario_maql, *args, **kwargs): # n self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.metric_id = metric_id - self.metric_type = metric_type - self.scenario_maql = scenario_maql + self.maql = maql for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_in_document.py new file mode 100644 index 000000000..fd26ed425 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_in import JsonApiComputedAttributeIn + globals()['JsonApiComputedAttributeIn'] = JsonApiComputedAttributeIn + + +class JsonApiComputedAttributeInDocument(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': (JsonApiComputedAttributeIn,), # 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 + """JsonApiComputedAttributeInDocument - a model defined in OpenAPI + + Args: + data (JsonApiComputedAttributeIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiComputedAttributeInDocument - a model defined in OpenAPI + + Args: + data (JsonApiComputedAttributeIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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/object_reference.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_linkage.py similarity index 93% rename from gooddata-api-client/gooddata_api_client/model/object_reference.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_linkage.py index 32c87649c..0e0a5e581 100644 --- a/gooddata-api-client/gooddata_api_client/model/object_reference.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_linkage.py @@ -31,7 +31,7 @@ -class ObjectReference(ModelNormal): +class JsonApiComputedAttributeLinkage(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,10 +57,7 @@ class ObjectReference(ModelNormal): allowed_values = { ('type',): { - 'WIDGET': "WIDGET", - 'METRIC': "METRIC", - 'ATTRIBUTE': "ATTRIBUTE", - 'DASHBOARD': "DASHBOARD", + 'COMPUTEDATTRIBUTE': "computedAttribute", }, } @@ -109,14 +106,14 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 - """ObjectReference - a model defined in OpenAPI + def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeLinkage - a model defined in OpenAPI Args: - id (str): Object identifier (e.g. widget ID, metric ID). - type (str): Type of the referenced object. + id (str): Keyword Args: + type (str): defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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. @@ -149,6 +146,7 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "computedAttribute") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -200,14 +198,14 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, type, *args, **kwargs): # noqa: E501 - """ObjectReference - a model defined in OpenAPI + def __init__(self, id, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeLinkage - a model defined in OpenAPI Args: - id (str): Object identifier (e.g. widget ID, metric ID). - type (str): Type of the referenced object. + id (str): Keyword Args: + type (str): defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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. @@ -240,6 +238,7 @@ def __init__(self, id, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "computedAttribute") _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/json_api_computed_attribute_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out.py new file mode 100644 index 000000000..91d8f011d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_attributes import JsonApiComputedAttributeOutAttributes + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutAttributes'] = JsonApiComputedAttributeOutAttributes + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships + + +class JsonApiComputedAttributeOut(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',): { + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, + } + + 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': (JsonApiComputedAttributeOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # 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 + """JsonApiComputedAttributeOut - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributeOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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 (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "computedAttribute") + _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 + """JsonApiComputedAttributeOut - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributeOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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 (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "computedAttribute") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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/search_result_object.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_attributes.py similarity index 68% rename from gooddata-api-client/gooddata_api_client/model/search_result_object.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_attributes.py index 1e68b9545..8200b43c4 100644 --- a/gooddata-api-client/gooddata_api_client/model/search_result_object.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_attributes.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.certification_info import CertificationInfo - globals()['CertificationInfo'] = CertificationInfo + from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent + globals()['JsonApiComputedAttributeInAttributesContent'] = JsonApiComputedAttributeInAttributesContent -class SearchResultObject(ModelNormal): +class JsonApiComputedAttributeOutAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -60,10 +60,53 @@ class SearchResultObject(ModelNormal): """ allowed_values = { + ('certification',): { + 'CERTIFIED': "CERTIFIED", + }, + ('data_type',): { + 'INT': "INT", + 'STRING': "STRING", + 'DATE': "DATE", + 'NUMERIC': "NUMERIC", + 'TIMESTAMP': "TIMESTAMP", + 'TIMESTAMP_TZ': "TIMESTAMP_TZ", + 'BOOLEAN': "BOOLEAN", + 'HLL': "HLL", + }, + ('value_type',): { + 'TEXT': "TEXT", + 'HYPERLINK': "HYPERLINK", + 'GEO': "GEO", + 'GEO_LONGITUDE': "GEO_LONGITUDE", + 'GEO_LATITUDE': "GEO_LATITUDE", + 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", + 'IMAGE': "IMAGE", + 'HYPERLOGLOG': "HYPERLOGLOG", + }, } validations = { - ('tags',): { + ('certified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('created_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('description',): { + 'max_length': 10000, + }, + ('modified_at',): { + 'regex': { + 'pattern': r'[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}', # noqa: E501 + }, + }, + ('title',): { + 'max_length': 255, }, } @@ -90,21 +133,22 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'workspace_id': (str,), # noqa: E501 - 'certification': (CertificationInfo,), # noqa: E501 - 'created_at': (datetime,), # noqa: E501 + 'content': (JsonApiComputedAttributeInAttributesContent,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'certification': (str,), # noqa: E501 + 'certification_message': (str, none_type,), # noqa: E501 + 'certified_at': (datetime, none_type,), # noqa: E501 + 'created_at': (datetime, none_type,), # noqa: E501 + 'data_type': (str,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 - 'modified_at': (datetime,), # noqa: E501 - 'score': (float,), # noqa: E501 - 'score_descriptor': (float,), # noqa: E501 - 'score_exact_match': (int,), # noqa: E501 - 'score_title': (float,), # noqa: E501 + 'is_nullable': (bool,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'modified_at': (datetime, none_type,), # noqa: E501 + 'null_value': (str,), # noqa: E501 'tags': ([str],), # noqa: E501 - 'visualization_url': (str,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'value_type': (str,), # noqa: E501 } @cached_property @@ -113,21 +157,22 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 - 'type': 'type', # noqa: E501 - 'workspace_id': 'workspaceId', # noqa: E501 + 'content': 'content', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 'certification': 'certification', # noqa: E501 + 'certification_message': 'certificationMessage', # noqa: E501 + 'certified_at': 'certifiedAt', # noqa: E501 'created_at': 'createdAt', # noqa: E501 + 'data_type': 'dataType', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 + 'is_nullable': 'isNullable', # noqa: E501 + 'locale': 'locale', # noqa: E501 'modified_at': 'modifiedAt', # noqa: E501 - 'score': 'score', # noqa: E501 - 'score_descriptor': 'scoreDescriptor', # noqa: E501 - 'score_exact_match': 'scoreExactMatch', # noqa: E501 - 'score_title': 'scoreTitle', # noqa: E501 + 'null_value': 'nullValue', # noqa: E501 'tags': 'tags', # noqa: E501 - 'visualization_url': 'visualizationUrl', # noqa: E501 + 'title': 'title', # noqa: E501 + 'value_type': 'valueType', # noqa: E501 } read_only_vars = { @@ -137,14 +182,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, type, workspace_id, *args, **kwargs): # noqa: E501 - """SearchResultObject - a model defined in OpenAPI + def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeOutAttributes - a model defined in OpenAPI Args: - id (str): Object ID. - title (str): Object title. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -177,17 +219,21 @@ def _from_openapi_data(cls, id, title, type, workspace_id, *args, **kwargs): # Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - certification (CertificationInfo): [optional] # noqa: E501 - created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 - description (str): Object description.. [optional] # noqa: E501 - is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 - modified_at (datetime): Timestamp when object was last modified.. [optional] # noqa: E501 - score (float): Result score calculated by a similarity search algorithm (cosine_distance).. [optional] # noqa: E501 - score_descriptor (float): Result score for descriptor containing(now) description and tags.. [optional] # noqa: E501 - score_exact_match (int): Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.. [optional] # noqa: E501 - score_title (float): Result score for object title.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 + certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 + certified_at (datetime, none_type): Time when the certification was set.. [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_hidden (bool): [optional] # noqa: E501 + is_nullable (bool): [optional] # noqa: E501 + locale (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + null_value (str): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 - visualization_url (str): If the object is visualization, this field defines the type of visualization.. [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -219,10 +265,7 @@ def _from_openapi_data(cls, id, title, type, workspace_id, *args, **kwargs): # self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.title = title - self.type = type - self.workspace_id = workspace_id + self.content = content for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -243,14 +286,11 @@ def _from_openapi_data(cls, id, title, type, workspace_id, *args, **kwargs): # ]) @convert_js_args_to_python_args - def __init__(self, id, title, type, workspace_id, *args, **kwargs): # noqa: E501 - """SearchResultObject - a model defined in OpenAPI + def __init__(self, content, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeOutAttributes - a model defined in OpenAPI Args: - id (str): Object ID. - title (str): Object title. - type (str): Object type, e.g. dashboard. - workspace_id (str): Workspace ID. + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -283,17 +323,21 @@ def __init__(self, id, title, type, workspace_id, *args, **kwargs): # noqa: E50 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - certification (CertificationInfo): [optional] # noqa: E501 - created_at (datetime): Timestamp when object was created.. [optional] # noqa: E501 - description (str): Object description.. [optional] # noqa: E501 - is_hidden (bool): If true, this object is hidden from AI search results by default.. [optional] # noqa: E501 - modified_at (datetime): Timestamp when object was last modified.. [optional] # noqa: E501 - score (float): Result score calculated by a similarity search algorithm (cosine_distance).. [optional] # noqa: E501 - score_descriptor (float): Result score for descriptor containing(now) description and tags.. [optional] # noqa: E501 - score_exact_match (int): Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.. [optional] # noqa: E501 - score_title (float): Result score for object title.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 + certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 + certified_at (datetime, none_type): Time when the certification was set.. [optional] # noqa: E501 + created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_hidden (bool): [optional] # noqa: E501 + is_nullable (bool): [optional] # noqa: E501 + locale (str): [optional] # noqa: E501 + modified_at (datetime, none_type): Time of the last entity modification.. [optional] # noqa: E501 + null_value (str): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 - visualization_url (str): If the object is visualization, this field defines the type of visualization.. [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -323,10 +367,7 @@ def __init__(self, id, title, type, workspace_id, *args, **kwargs): # noqa: E50 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.title = title - self.type = type - self.workspace_id = workspace_id + self.content = content 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/search_result.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_document.py similarity index 84% rename from gooddata-api-client/gooddata_api_client/model/search_result.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_document.py index 0811b3954..c94d86efb 100644 --- a/gooddata-api-client/gooddata_api_client/model/search_result.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_document.py @@ -31,15 +31,17 @@ def lazy_import(): - from gooddata_api_client.model.error_info import ErrorInfo - from gooddata_api_client.model.search_relationship_object import SearchRelationshipObject - from gooddata_api_client.model.search_result_object import SearchResultObject - globals()['ErrorInfo'] = ErrorInfo - globals()['SearchRelationshipObject'] = SearchRelationshipObject - globals()['SearchResultObject'] = SearchResultObject + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_computed_attribute_out import JsonApiComputedAttributeOut + from gooddata_api_client.model.json_api_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes + from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta + globals()['JsonApiComputedAttributeOut'] = JsonApiComputedAttributeOut + globals()['JsonApiComputedAttributeOutIncludes'] = JsonApiComputedAttributeOutIncludes + globals()['ObjectLinks'] = ObjectLinks -class SearchResult(ModelNormal): +class JsonApiComputedAttributeOutDocument(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -67,6 +69,8 @@ class SearchResult(ModelNormal): } validations = { + ('included',): { + }, } @cached_property @@ -92,10 +96,10 @@ def openapi_types(): """ lazy_import() return { - 'reasoning': (str,), # noqa: E501 - 'relationships': ([SearchRelationshipObject],), # noqa: E501 - 'results': ([SearchResultObject],), # noqa: E501 - 'error': (ErrorInfo,), # noqa: E501 + 'data': (JsonApiComputedAttributeOut,), # noqa: E501 + 'included': ([JsonApiComputedAttributeOutIncludes],), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -104,10 +108,10 @@ def discriminator(): attribute_map = { - 'reasoning': 'reasoning', # noqa: E501 - 'relationships': 'relationships', # noqa: E501 - 'results': 'results', # noqa: E501 - 'error': 'error', # noqa: E501 + 'data': 'data', # noqa: E501 + 'included': 'included', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -117,13 +121,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, reasoning, relationships, results, *args, **kwargs): # noqa: E501 - """SearchResult - a model defined in OpenAPI + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeOutDocument - a model defined in OpenAPI Args: - reasoning (str): DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation. - relationships ([SearchRelationshipObject]): - results ([SearchResultObject]): + data (JsonApiComputedAttributeOut): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -156,7 +158,9 @@ def _from_openapi_data(cls, reasoning, relationships, results, *args, **kwargs): Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - error (ErrorInfo): [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -188,9 +192,7 @@ def _from_openapi_data(cls, reasoning, relationships, results, *args, **kwargs): self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.reasoning = reasoning - self.relationships = relationships - self.results = results + 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 \ @@ -211,13 +213,11 @@ def _from_openapi_data(cls, reasoning, relationships, results, *args, **kwargs): ]) @convert_js_args_to_python_args - def __init__(self, reasoning, relationships, results, *args, **kwargs): # noqa: E501 - """SearchResult - a model defined in OpenAPI + def __init__(self, data, *args, **kwargs): # noqa: E501 + """JsonApiComputedAttributeOutDocument - a model defined in OpenAPI Args: - reasoning (str): DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation. - relationships ([SearchRelationshipObject]): - results ([SearchResultObject]): + data (JsonApiComputedAttributeOut): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -250,7 +250,9 @@ def __init__(self, reasoning, relationships, results, *args, **kwargs): # noqa: Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - error (ErrorInfo): [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -280,9 +282,7 @@ def __init__(self, reasoning, relationships, results, *args, **kwargs): # noqa: self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.reasoning = reasoning - self.relationships = relationships - self.results = results + 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_includes.py similarity index 97% rename from gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_includes.py index c528b46cd..bfa71a4a8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_includes.py @@ -33,6 +33,7 @@ def lazy_import(): from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks + from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks from gooddata_api_client.model.json_api_dashboard_plugin_out_relationships import JsonApiDashboardPluginOutRelationships from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks @@ -44,6 +45,7 @@ def lazy_import(): from gooddata_api_client.model.object_links import ObjectLinks globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks + globals()['JsonApiComputedAttributeOutWithLinks'] = JsonApiComputedAttributeOutWithLinks globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks @@ -55,7 +57,7 @@ def lazy_import(): globals()['ObjectLinks'] = ObjectLinks -class JsonApiMetricOutIncludes(ModelComposed): +class JsonApiComputedAttributeOutIncludes(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -144,7 +146,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutIncludes - a model defined in OpenAPI + """JsonApiComputedAttributeOutIncludes - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -253,7 +255,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutIncludes - a model defined in OpenAPI + """JsonApiComputedAttributeOutIncludes - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -364,6 +366,7 @@ def _composed_schemas(): ], 'oneOf': [ JsonApiAttributeOutWithLinks, + JsonApiComputedAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_list.py new file mode 100644 index 000000000..4a3184d7b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes + from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks + from gooddata_api_client.model.list_links import ListLinks + globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiComputedAttributeOutIncludes'] = JsonApiComputedAttributeOutIncludes + globals()['JsonApiComputedAttributeOutWithLinks'] = JsonApiComputedAttributeOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiComputedAttributeOutList(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': ([JsonApiComputedAttributeOutWithLinks],), # noqa: E501 + 'included': ([JsonApiComputedAttributeOutIncludes],), # 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 + """JsonApiComputedAttributeOutList - a model defined in OpenAPI + + Args: + data ([JsonApiComputedAttributeOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 ([JsonApiComputedAttributeOutIncludes]): 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 + """JsonApiComputedAttributeOutList - a model defined in OpenAPI + + Args: + data ([JsonApiComputedAttributeOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 ([JsonApiComputedAttributeOutIncludes]): 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_metric_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_relationships.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/json_api_metric_out_relationships.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_relationships.py index ea027ddb8..5d3a0e02d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_relationships.py @@ -32,22 +32,24 @@ def lazy_import(): from gooddata_api_client.model.json_api_agent_out_relationships_created_by import JsonApiAgentOutRelationshipsCreatedBy + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_computed_attributes import JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_parameters import JsonApiAnalyticalDashboardOutRelationshipsParameters from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts + from gooddata_api_client.model.json_api_automation_out_relationships_facts import JsonApiAutomationOutRelationshipsFacts globals()['JsonApiAgentOutRelationshipsCreatedBy'] = JsonApiAgentOutRelationshipsCreatedBy + globals()['JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes'] = JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics globals()['JsonApiAnalyticalDashboardOutRelationshipsParameters'] = JsonApiAnalyticalDashboardOutRelationshipsParameters globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiDatasetOutRelationshipsFacts'] = JsonApiDatasetOutRelationshipsFacts + globals()['JsonApiAutomationOutRelationshipsFacts'] = JsonApiAutomationOutRelationshipsFacts -class JsonApiMetricOutRelationships(ModelNormal): +class JsonApiComputedAttributeOutRelationships(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -102,9 +104,10 @@ def openapi_types(): return { 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 'certified_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 + 'computed_attributes': (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes,), # noqa: E501 'created_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 + 'facts': (JsonApiAutomationOutRelationshipsFacts,), # noqa: E501 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 'modified_by': (JsonApiAgentOutRelationshipsCreatedBy,), # noqa: E501 @@ -119,6 +122,7 @@ def discriminator(): attribute_map = { 'attributes': 'attributes', # noqa: E501 'certified_by': 'certifiedBy', # noqa: E501 + 'computed_attributes': 'computedAttributes', # noqa: E501 'created_by': 'createdBy', # noqa: E501 'datasets': 'datasets', # noqa: E501 'facts': 'facts', # noqa: E501 @@ -136,7 +140,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutRelationships - a model defined in OpenAPI + """JsonApiComputedAttributeOutRelationships - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -171,9 +175,10 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 certified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 created_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 modified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 @@ -230,7 +235,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """JsonApiMetricOutRelationships - a model defined in OpenAPI + """JsonApiComputedAttributeOutRelationships - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -265,9 +270,10 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 certified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 created_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 modified_by (JsonApiAgentOutRelationshipsCreatedBy): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_out_with_links.py new file mode 100644 index 000000000..9b1ac34b5 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out import JsonApiComputedAttributeOut + from gooddata_api_client.model.json_api_computed_attribute_out_attributes import JsonApiComputedAttributeOutAttributes + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships + from gooddata_api_client.model.object_links import ObjectLinks + from gooddata_api_client.model.object_links_container import ObjectLinksContainer + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOut'] = JsonApiComputedAttributeOut + globals()['JsonApiComputedAttributeOutAttributes'] = JsonApiComputedAttributeOutAttributes + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiComputedAttributeOutWithLinks(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',): { + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, + } + + 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': (JsonApiComputedAttributeOutAttributes,), # noqa: E501 + 'id': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # 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 + """JsonApiComputedAttributeOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiComputedAttributeOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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 (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "computedAttribute") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiComputedAttributeOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiComputedAttributeOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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 (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + """ + + type = kwargs.get('type', "computedAttribute") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiComputedAttributeOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch.py new file mode 100644 index 000000000..f8bb433c4 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_patch_attributes import JsonApiComputedAttributePatchAttributes + globals()['JsonApiComputedAttributePatchAttributes'] = JsonApiComputedAttributePatchAttributes + + +class JsonApiComputedAttributePatch(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',): { + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, + } + + 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': (JsonApiComputedAttributePatchAttributes,), # 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 + """JsonApiComputedAttributePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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', "computedAttribute") + _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 + """JsonApiComputedAttributePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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', "computedAttribute") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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/chat_history_request.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch_attributes.py similarity index 75% rename from gooddata-api-client/gooddata_api_client/model/chat_history_request.py rename to gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch_attributes.py index 9742b880b..88947fcb7 100644 --- a/gooddata-api-client/gooddata_api_client/model/chat_history_request.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch_attributes.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.saved_visualization import SavedVisualization - globals()['SavedVisualization'] = SavedVisualization + from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent + globals()['JsonApiComputedAttributeInAttributesContent'] = JsonApiComputedAttributeInAttributesContent -class ChatHistoryRequest(ModelNormal): +class JsonApiComputedAttributePatchAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -60,23 +60,36 @@ class ChatHistoryRequest(ModelNormal): """ allowed_values = { - ('response_state',): { - 'SUCCESSFUL': "SUCCESSFUL", - 'UNEXPECTED_ERROR': "UNEXPECTED_ERROR", - 'NOT_FOUND_ATTRIBUTES': "NOT_FOUND_ATTRIBUTES", - 'TOO_MANY_DATA_POINTS': "TOO_MANY_DATA_POINTS", - 'NO_DATA': "NO_DATA", - 'NO_RESULTS': "NO_RESULTS", - 'OUT_OF_TOPIC': "OUT_OF_TOPIC", + ('data_type',): { + 'INT': "INT", + 'STRING': "STRING", + 'DATE': "DATE", + 'NUMERIC': "NUMERIC", + 'TIMESTAMP': "TIMESTAMP", + 'TIMESTAMP_TZ': "TIMESTAMP_TZ", + 'BOOLEAN': "BOOLEAN", + 'HLL': "HLL", }, - ('user_feedback',): { - 'POSITIVE': "POSITIVE", - 'NEGATIVE': "NEGATIVE", - 'NONE': "NONE", + ('value_type',): { + 'TEXT': "TEXT", + 'HYPERLINK': "HYPERLINK", + 'GEO': "GEO", + 'GEO_LONGITUDE': "GEO_LONGITUDE", + 'GEO_LATITUDE': "GEO_LATITUDE", + 'GEO_AREA': "GEO_AREA", + 'GEO_ICON': "GEO_ICON", + 'IMAGE': "IMAGE", + 'HYPERLOGLOG': "HYPERLOGLOG", }, } validations = { + ('description',): { + 'max_length': 10000, + }, + ('title',): { + 'max_length': 255, + }, } @cached_property @@ -102,13 +115,17 @@ def openapi_types(): """ lazy_import() return { - 'chat_history_interaction_id': (str,), # noqa: E501 - 'reset': (bool,), # noqa: E501 - 'response_state': (str,), # noqa: E501 - 'saved_visualization': (SavedVisualization,), # noqa: E501 - 'thread_id_suffix': (str,), # noqa: E501 - 'user_feedback': (str,), # noqa: E501 - 'user_text_feedback': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'content': (JsonApiComputedAttributeInAttributesContent,), # noqa: E501 + 'data_type': (str,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'is_hidden': (bool,), # noqa: E501 + 'is_nullable': (bool,), # noqa: E501 + 'locale': (str,), # noqa: E501 + 'null_value': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'value_type': (str,), # noqa: E501 } @cached_property @@ -117,13 +134,17 @@ def discriminator(): attribute_map = { - 'chat_history_interaction_id': 'chatHistoryInteractionId', # noqa: E501 - 'reset': 'reset', # noqa: E501 - 'response_state': 'responseState', # noqa: E501 - 'saved_visualization': 'savedVisualization', # noqa: E501 - 'thread_id_suffix': 'threadIdSuffix', # noqa: E501 - 'user_feedback': 'userFeedback', # noqa: E501 - 'user_text_feedback': 'userTextFeedback', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'content': 'content', # noqa: E501 + 'data_type': 'dataType', # noqa: E501 + 'description': 'description', # noqa: E501 + 'is_hidden': 'isHidden', # noqa: E501 + 'is_nullable': 'isNullable', # noqa: E501 + 'locale': 'locale', # noqa: E501 + 'null_value': 'nullValue', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'value_type': 'valueType', # noqa: E501 } read_only_vars = { @@ -134,7 +155,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """ChatHistoryRequest - a model defined in OpenAPI + """JsonApiComputedAttributePatchAttributes - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -167,13 +188,17 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - chat_history_interaction_id (str): Return chat history records only after this interaction ID. If empty, complete chat history is returned.. [optional] # noqa: E501 - reset (bool): User feedback.. [optional] # noqa: E501 - response_state (str): Response state indicating the outcome of the AI interaction.. [optional] # noqa: E501 - saved_visualization (SavedVisualization): [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [optional] # noqa: E501 - user_text_feedback (str): User text feedback for the interaction.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + content (JsonApiComputedAttributeInAttributesContent): [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_hidden (bool): [optional] # noqa: E501 + is_nullable (bool): [optional] # noqa: E501 + locale (str): [optional] # noqa: E501 + null_value (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -226,7 +251,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """ChatHistoryRequest - a model defined in OpenAPI + """JsonApiComputedAttributePatchAttributes - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -259,13 +284,17 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - chat_history_interaction_id (str): Return chat history records only after this interaction ID. If empty, complete chat history is returned.. [optional] # noqa: E501 - reset (bool): User feedback.. [optional] # noqa: E501 - response_state (str): Response state indicating the outcome of the AI interaction.. [optional] # noqa: E501 - saved_visualization (SavedVisualization): [optional] # noqa: E501 - thread_id_suffix (str): Chat History thread suffix appended to ID generated by backend. Enables more chat windows.. [optional] # noqa: E501 - user_feedback (str): User feedback.. [optional] # noqa: E501 - user_text_feedback (str): User text feedback for the interaction.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + content (JsonApiComputedAttributeInAttributesContent): [optional] # noqa: E501 + data_type (str): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + is_hidden (bool): [optional] # noqa: E501 + is_nullable (bool): [optional] # noqa: E501 + locale (str): [optional] # noqa: E501 + null_value (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + value_type (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_patch_document.py new file mode 100644 index 000000000..6387c76c6 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_patch import JsonApiComputedAttributePatch + globals()['JsonApiComputedAttributePatch'] = JsonApiComputedAttributePatch + + +class JsonApiComputedAttributePatchDocument(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': (JsonApiComputedAttributePatch,), # 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 + """JsonApiComputedAttributePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiComputedAttributePatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiComputedAttributePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiComputedAttributePatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_computed_attribute_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_post_optional_id.py new file mode 100644 index 000000000..d07e9f762 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_in_attributes import JsonApiComputedAttributeInAttributes + globals()['JsonApiComputedAttributeInAttributes'] = JsonApiComputedAttributeInAttributes + + +class JsonApiComputedAttributePostOptionalId(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',): { + 'COMPUTEDATTRIBUTE': "computedAttribute", + }, + } + + 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': (JsonApiComputedAttributeInAttributes,), # 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 + """JsonApiComputedAttributePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributeInAttributes): + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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', "computedAttribute") + _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 + """JsonApiComputedAttributePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiComputedAttributeInAttributes): + + Keyword Args: + type (str): Object type. defaults to "computedAttribute", must be one of ["computedAttribute", ] # 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', "computedAttribute") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_computed_attribute_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_post_optional_id_document.py new file mode 100644 index 000000000..d572e47c9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_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_computed_attribute_post_optional_id import JsonApiComputedAttributePostOptionalId + globals()['JsonApiComputedAttributePostOptionalId'] = JsonApiComputedAttributePostOptionalId + + +class JsonApiComputedAttributePostOptionalIdDocument(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': (JsonApiComputedAttributePostOptionalId,), # 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 + """JsonApiComputedAttributePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiComputedAttributePostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiComputedAttributePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiComputedAttributePostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_computed_attribute_to_many_linkage.py b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_to_many_linkage.py new file mode 100644 index 000000000..f6834c42d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_computed_attribute_to_many_linkage.py @@ -0,0 +1,292 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.json_api_computed_attribute_linkage import JsonApiComputedAttributeLinkage + globals()['JsonApiComputedAttributeLinkage'] = JsonApiComputedAttributeLinkage + + +class JsonApiComputedAttributeToManyLinkage(ModelSimple): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + additional_properties_type = None + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'value': ([JsonApiComputedAttributeLinkage],), + } + + @cached_property + def discriminator(): + return None + + + attribute_map = {} + + read_only_vars = set() + + _composed_schemas = None + + 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): + """JsonApiComputedAttributeToManyLinkage - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([JsonApiComputedAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 + + Keyword Args: + value ([JsonApiComputedAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): + """JsonApiComputedAttributeToManyLinkage - a model defined in OpenAPI + + Note that value can be passed either in args or in kwargs, but not in both. + + Args: + args[0] ([JsonApiComputedAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # noqa: E501 + + Keyword Args: + value ([JsonApiComputedAttributeLinkage]): References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.. # 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,) + """ + # required up here when default value is not given + _path_to_item = kwargs.pop('_path_to_item', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if 'value' in kwargs: + value = kwargs.pop('value') + elif args: + args = list(args) + value = args.pop(0) + else: + raise ApiTypeError( + "value is required, but not passed in args or kwargs and doesn't have default", + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.value = value + if kwargs: + raise ApiTypeError( + "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % ( + kwargs, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + return self diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py index 3aa6f713e..cbaddec19 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_csp_directive_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_csp_directive_out_with_links import JsonApiCspDirectiveOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiCspDirectiveOutWithLinks'] = JsonApiCspDirectiveOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiCspDirectiveOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py index 2819722ff..14ce7df34 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_application_setting_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_custom_application_setting_out_with_links import JsonApiCustomApplicationSettingOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiCustomApplicationSettingOutWithLinks'] = JsonApiCustomApplicationSettingOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiCustomApplicationSettingOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.py index 4fb241044..e47841bbd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_geo_collection_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_custom_geo_collection_out_with_links import JsonApiCustomGeoCollectionOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiCustomGeoCollectionOutWithLinks'] = JsonApiCustomGeoCollectionOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiCustomGeoCollectionOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_custom_user_application_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_custom_user_application_setting_out_list.py index a2aff84c1..74e12e77d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_custom_user_application_setting_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_custom_user_application_setting_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_custom_user_application_setting_out_with_links import JsonApiCustomUserApplicationSettingOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiCustomUserApplicationSettingOutWithLinks'] = JsonApiCustomUserApplicationSettingOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiCustomUserApplicationSettingOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py index e94476ad0..b737c92cb 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dashboard_plugin_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_dashboard_plugin_out import JsonApiDashboardPluginOut 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()['JsonApiDashboardPluginOut'] = JsonApiDashboardPluginOut globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiDashboardPluginOut,), # noqa: E501 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _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) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _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) 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 273126958..04783c753 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 @@ -84,6 +84,7 @@ class JsonApiDataSourceIdentifierOutAttributes(ModelNormal): 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", + 'TRINO': "TRINO", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py index 8814fc680..140849e3d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_identifier_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_data_source_identifier_out_with_links import JsonApiDataSourceIdentifierOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiDataSourceIdentifierOutWithLinks'] = JsonApiDataSourceIdentifierOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiDataSourceIdentifierOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) 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 11d911a66..d5198e8c5 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 @@ -90,6 +90,7 @@ class JsonApiDataSourceInAttributes(ModelNormal): 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", + 'TRINO': "TRINO", }, ('authentication_type',): { 'None': None, @@ -182,6 +183,7 @@ def openapi_types(): 'client_id': (str, none_type,), # noqa: E501 'client_secret': (str, none_type,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 + 'disable_statistics': (bool, none_type,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'password': (str, none_type,), # noqa: E501 'private_key': (str, none_type,), # noqa: E501 @@ -207,6 +209,7 @@ def discriminator(): 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 + 'disable_statistics': 'disableStatistics', # noqa: E501 'parameters': 'parameters', # noqa: E501 'password': 'password', # noqa: E501 'private_key': 'privateKey', # noqa: E501 @@ -269,6 +272,7 @@ def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 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 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 @@ -376,6 +380,7 @@ def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 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 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 7382e6a73..f152172fb 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 @@ -90,6 +90,7 @@ class JsonApiDataSourceOutAttributes(ModelNormal): 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", + 'TRINO': "TRINO", }, ('authentication_type',): { 'None': None, @@ -167,6 +168,7 @@ def openapi_types(): 'client_id': (str, none_type,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 'decoded_parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 + 'disable_statistics': (bool, none_type,), # noqa: E501 'managed': (bool,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'url': (str, none_type,), # noqa: E501 @@ -189,6 +191,7 @@ def discriminator(): 'client_id': 'clientId', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 'decoded_parameters': 'decodedParameters', # noqa: E501 + 'disable_statistics': 'disableStatistics', # noqa: E501 'managed': 'managed', # noqa: E501 'parameters': 'parameters', # noqa: E501 'url': 'url', # noqa: E501 @@ -248,6 +251,7 @@ def _from_openapi_data(cls, name, schema, type, *args, **kwargs): # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 date_time_semantics (str, none_type): Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.. [optional] # noqa: E501 decoded_parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Decoded parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 + 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 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 @@ -352,6 +356,7 @@ def __init__(self, name, schema, type, *args, **kwargs): # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 date_time_semantics (str, none_type): Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.. [optional] # noqa: E501 decoded_parameters ([JsonApiDataSourceInAttributesParametersInner], none_type): Decoded parameters to be used when connecting to the database providing the data for the data source.. [optional] # noqa: E501 + 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 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_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.py index 4679e5914..e7d65b616 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_data_source_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_data_source_out_with_links import JsonApiDataSourceOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiDataSourceOutWithLinks'] = JsonApiDataSourceOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiDataSourceOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) 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 51d3e95fb..04fd529da 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 @@ -108,6 +108,7 @@ class JsonApiDataSourcePatchAttributes(ModelNormal): 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", + 'TRINO': "TRINO", }, } @@ -179,6 +180,7 @@ def openapi_types(): 'client_id': (str, none_type,), # noqa: E501 'client_secret': (str, none_type,), # noqa: E501 'date_time_semantics': (str, none_type,), # noqa: E501 + 'disable_statistics': (bool, none_type,), # noqa: E501 'name': (str,), # noqa: E501 'parameters': ([JsonApiDataSourceInAttributesParametersInner], none_type,), # noqa: E501 'password': (str, none_type,), # noqa: E501 @@ -204,6 +206,7 @@ def discriminator(): 'client_id': 'clientId', # noqa: E501 'client_secret': 'clientSecret', # noqa: E501 'date_time_semantics': 'dateTimeSemantics', # noqa: E501 + 'disable_statistics': 'disableStatistics', # noqa: E501 'name': 'name', # noqa: E501 'parameters': 'parameters', # noqa: E501 'password': 'password', # noqa: E501 @@ -264,6 +267,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 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 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 @@ -366,6 +370,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 client_id (str, none_type): The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 client_secret (str, none_type): The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).. [optional] # noqa: E501 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 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_dataset_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.py index 9b9a606c5..cabcc7d7e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_dataset_out import JsonApiDatasetOut from gooddata_api_client.model.json_api_dataset_out_includes import JsonApiDatasetOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiDatasetOut'] = JsonApiDatasetOut globals()['JsonApiDatasetOutIncludes'] = JsonApiDatasetOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiDatasetOut,), # noqa: E501 'included': ([JsonApiDatasetOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiDatasetOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiDatasetOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py index b518ea522..8569d36a5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_out_relationships.py @@ -33,13 +33,13 @@ def lazy_import(): from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes + from gooddata_api_client.model.json_api_automation_out_relationships_facts import JsonApiAutomationOutRelationshipsFacts from gooddata_api_client.model.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts - from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts from gooddata_api_client.model.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes + globals()['JsonApiAutomationOutRelationshipsFacts'] = JsonApiAutomationOutRelationshipsFacts globals()['JsonApiDatasetOutRelationshipsAggregatedFacts'] = JsonApiDatasetOutRelationshipsAggregatedFacts - globals()['JsonApiDatasetOutRelationshipsFacts'] = JsonApiDatasetOutRelationshipsFacts globals()['JsonApiDatasetOutRelationshipsWorkspaceDataFilters'] = JsonApiDatasetOutRelationshipsWorkspaceDataFilters @@ -98,7 +98,7 @@ def openapi_types(): return { 'aggregated_facts': (JsonApiDatasetOutRelationshipsAggregatedFacts,), # noqa: E501 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 - 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 + 'facts': (JsonApiAutomationOutRelationshipsFacts,), # noqa: E501 'references': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 'workspace_data_filters': (JsonApiDatasetOutRelationshipsWorkspaceDataFilters,), # noqa: E501 } @@ -159,7 +159,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) aggregated_facts (JsonApiDatasetOutRelationshipsAggregatedFacts): [optional] # noqa: E501 attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 references (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 workspace_data_filters (JsonApiDatasetOutRelationshipsWorkspaceDataFilters): [optional] # noqa: E501 """ @@ -249,7 +249,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) aggregated_facts (JsonApiDatasetOutRelationshipsAggregatedFacts): [optional] # noqa: E501 attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 references (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 workspace_data_filters (JsonApiDatasetOutRelationshipsWorkspaceDataFilters): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.py index 83e0e12ed..f932e4586 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_attribute_patch_attributes import JsonApiAttributePatchAttributes - globals()['JsonApiAttributePatchAttributes'] = JsonApiAttributePatchAttributes + from gooddata_api_client.model.json_api_dataset_patch_attributes import JsonApiDatasetPatchAttributes + globals()['JsonApiDatasetPatchAttributes'] = JsonApiDatasetPatchAttributes class JsonApiDatasetPatch(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributePatchAttributes,), # noqa: E501 + 'attributes': (JsonApiDatasetPatchAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiAttributePatchAttributes): [optional] # noqa: E501 + attributes (JsonApiDatasetPatchAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "dataset") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiAttributePatchAttributes): [optional] # noqa: E501 + attributes (JsonApiDatasetPatchAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "dataset") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_attributes.py new file mode 100644 index 000000000..abae054c1 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_dataset_patch_attributes.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 + + + +class JsonApiDatasetPatchAttributes(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 + """ + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + return { + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiDatasetPatchAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): [optional] # noqa: E501 + tags ([str]): [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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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 + """JsonApiDatasetPatchAttributes - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + description (str): [optional] # noqa: E501 + tags ([str]): [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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_entitlement_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.py index e6051b27e..303dcdfcc 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_entitlement_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_entitlement_out_with_links import JsonApiEntitlementOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiEntitlementOutWithLinks'] = JsonApiEntitlementOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiEntitlementOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py index 9ee948298..e7b59b47f 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_in_attributes_request_payload.py @@ -31,6 +31,7 @@ def lazy_import(): + from gooddata_api_client.model.conditional_formatting import ConditionalFormatting from gooddata_api_client.model.custom_override import CustomOverride from gooddata_api_client.model.execution_settings import ExecutionSettings from gooddata_api_client.model.json_node import JsonNode @@ -39,6 +40,7 @@ def lazy_import(): from gooddata_api_client.model.tabular_export_execution import TabularExportExecution from gooddata_api_client.model.tabular_export_request import TabularExportRequest from gooddata_api_client.model.visual_export_request import VisualExportRequest + globals()['ConditionalFormatting'] = ConditionalFormatting globals()['CustomOverride'] = CustomOverride globals()['ExecutionSettings'] = ExecutionSettings globals()['JsonNode'] = JsonNode @@ -110,6 +112,7 @@ def openapi_types(): return { 'metadata': (JsonNode,), # noqa: E501 'timezone_id': (str, none_type,), # noqa: E501 + 'conditional_formatting': (ConditionalFormatting,), # noqa: E501 'custom_override': (CustomOverride,), # noqa: E501 'execution_result': (str,), # noqa: E501 'execution_settings': (ExecutionSettings,), # noqa: E501 @@ -132,6 +135,7 @@ def discriminator(): attribute_map = { 'metadata': 'metadata', # noqa: E501 'timezone_id': 'timezoneId', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'custom_override': 'customOverride', # noqa: E501 'execution_result': 'executionResult', # noqa: E501 'execution_settings': 'executionSettings', # noqa: E501 @@ -187,6 +191,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 execution_settings (ExecutionSettings): [optional] # noqa: E501 @@ -304,6 +309,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) metadata (JsonNode): [optional] # noqa: E501 timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 execution_settings (ExecutionSettings): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py index 02c9df7d7..b3933e648 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_export_definition_out import JsonApiExportDefinitionOut from gooddata_api_client.model.json_api_export_definition_out_includes import JsonApiExportDefinitionOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiExportDefinitionOut'] = JsonApiExportDefinitionOut globals()['JsonApiExportDefinitionOutIncludes'] = JsonApiExportDefinitionOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiExportDefinitionOut,), # noqa: E501 'included': ([JsonApiExportDefinitionOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiExportDefinitionOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiExportDefinitionOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py index e59f88259..f97a91133 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_definition_out_includes.py @@ -31,18 +31,18 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiAutomationOutWithLinks'] = JsonApiAutomationOutWithLinks - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['JsonApiVisualizationObjectOutAttributes'] = JsonApiVisualizationObjectOutAttributes globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks @@ -110,8 +110,8 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 @@ -171,8 +171,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiVisualizationObjectOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 @@ -280,8 +280,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiVisualizationObjectOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py index 57d71bb46..58792d20e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_export_template_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_export_template_out_with_links import JsonApiExportTemplateOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiExportTemplateOutWithLinks'] = JsonApiExportTemplateOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiExportTemplateOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py index c977d12ca..a89da5c3e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiFactOutAttributes'] = JsonApiFactOutAttributes globals()['JsonApiFactOutRelationships'] = JsonApiFactOutRelationships @@ -103,7 +103,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 'attributes': (JsonApiFactOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiFactOutRelationships,), # noqa: E501 } @@ -166,7 +166,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 """ @@ -261,7 +261,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py index f38dcdde7..d2e8bbb72 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks globals()['JsonApiFactOut'] = JsonApiFactOut globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiFactOut,), # noqa: E501 'included': ([JsonApiDatasetOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiDatasetOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiDatasetOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py index f70b65e36..08e1b9f53 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_out_with_links.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_fact_out import JsonApiFactOut from gooddata_api_client.model.json_api_fact_out_attributes import JsonApiFactOutAttributes from gooddata_api_client.model.json_api_fact_out_relationships import JsonApiFactOutRelationships from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiFactOut'] = JsonApiFactOut globals()['JsonApiFactOutAttributes'] = JsonApiFactOutAttributes globals()['JsonApiFactOutRelationships'] = JsonApiFactOutRelationships @@ -109,7 +109,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 'attributes': (JsonApiFactOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiFactOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -170,7 +170,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -280,7 +280,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiFactOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiFactOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.py index 5bd9e71aa..15b57dc1b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fact_patch.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_attribute_patch_attributes import JsonApiAttributePatchAttributes - globals()['JsonApiAttributePatchAttributes'] = JsonApiAttributePatchAttributes + from gooddata_api_client.model.json_api_dataset_patch_attributes import JsonApiDatasetPatchAttributes + globals()['JsonApiDatasetPatchAttributes'] = JsonApiDatasetPatchAttributes class JsonApiFactPatch(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributePatchAttributes,), # noqa: E501 + 'attributes': (JsonApiDatasetPatchAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiAttributePatchAttributes): [optional] # noqa: E501 + attributes (JsonApiDatasetPatchAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "fact") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiAttributePatchAttributes): [optional] # noqa: E501 + attributes (JsonApiDatasetPatchAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "fact") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py index 38c8e1b3f..6cbc900f2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_filter_context_out import JsonApiFilterContextOut from gooddata_api_client.model.json_api_filter_context_out_includes import JsonApiFilterContextOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiFilterContextOut'] = JsonApiFilterContextOut globals()['JsonApiFilterContextOutIncludes'] = JsonApiFilterContextOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiFilterContextOut,), # noqa: E501 'included': ([JsonApiFilterContextOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiFilterContextOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiFilterContextOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py index 02cadb19a..fa5f25faa 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_includes.py @@ -31,19 +31,25 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships + from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks - from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes - from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships + from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks + from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes + from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships + globals()['JsonApiComputedAttributeOutWithLinks'] = JsonApiComputedAttributeOutWithLinks globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks - globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes - globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships + globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks + globals()['JsonApiMetricOutAttributes'] = JsonApiMetricOutAttributes + globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -73,7 +79,7 @@ class JsonApiFilterContextOutIncludes(ModelComposed): allowed_values = { ('type',): { - 'LABEL': "label", + 'METRIC': "metric", }, } @@ -108,10 +114,10 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 - 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 + 'attributes': (JsonApiMetricOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -169,12 +175,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 + attributes (JsonApiMetricOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "label" # noqa: E501 + type (str): Object type. [optional] if omitted the server will use the default value of "metric" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -278,12 +284,12 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 - attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 + attributes (JsonApiMetricOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 - type (str): Object type. [optional] if omitted the server will use the default value of "label" # noqa: E501 + type (str): Object type. [optional] if omitted the server will use the default value of "metric" # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -356,7 +362,10 @@ def _composed_schemas(): ], 'oneOf': [ JsonApiAttributeOutWithLinks, + JsonApiComputedAttributeOutWithLinks, JsonApiDatasetOutWithLinks, + JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, + JsonApiMetricOutWithLinks, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py index 0bebd66bc..6dfbc8b1a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_context_out_relationships.py @@ -31,12 +31,18 @@ def lazy_import(): + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_computed_attributes import JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes + from gooddata_api_client.model.json_api_automation_out_relationships_facts import JsonApiAutomationOutRelationshipsFacts + globals()['JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes'] = JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels + globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes + globals()['JsonApiAutomationOutRelationshipsFacts'] = JsonApiAutomationOutRelationshipsFacts class JsonApiFilterContextOutRelationships(ModelNormal): @@ -93,8 +99,11 @@ def openapi_types(): lazy_import() return { 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 + 'computed_attributes': (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes,), # noqa: E501 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 + 'facts': (JsonApiAutomationOutRelationshipsFacts,), # noqa: E501 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 + 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 } @cached_property @@ -104,8 +113,11 @@ def discriminator(): attribute_map = { 'attributes': 'attributes', # noqa: E501 + 'computed_attributes': 'computedAttributes', # noqa: E501 'datasets': 'datasets', # noqa: E501 + 'facts': 'facts', # noqa: E501 'labels': 'labels', # noqa: E501 + 'metrics': 'metrics', # noqa: E501 } read_only_vars = { @@ -150,8 +162,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 + metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -238,8 +253,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 + metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py index 0fc28f5b3..427fd4806 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_filter_view_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_filter_view_out import JsonApiFilterViewOut from gooddata_api_client.model.json_api_filter_view_out_includes import JsonApiFilterViewOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiFilterViewOut'] = JsonApiFilterViewOut globals()['JsonApiFilterViewOutIncludes'] = JsonApiFilterViewOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiFilterViewOut,), # noqa: E501 'included': ([JsonApiFilterViewOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiFilterViewOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiFilterViewOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_list.py index ec5eb9695..d7269cbe9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_fiscal_calendar_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_fiscal_calendar_out_with_links import JsonApiFiscalCalendarOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiFiscalCalendarOutWithLinks'] = JsonApiFiscalCalendarOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiFiscalCalendarOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py index 4001912c9..ab6796cae 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_identity_provider_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_identity_provider_out_with_links import JsonApiIdentityProviderOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiIdentityProviderOutWithLinks'] = JsonApiIdentityProviderOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiIdentityProviderOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_ip_allowlist_policy_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_ip_allowlist_policy_out_document.py index b489d7b79..3383def98 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_ip_allowlist_policy_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_ip_allowlist_policy_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_ip_allowlist_policy_out import JsonApiIpAllowlistPolicyOut from gooddata_api_client.model.json_api_ip_allowlist_policy_out_includes import JsonApiIpAllowlistPolicyOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiIpAllowlistPolicyOut'] = JsonApiIpAllowlistPolicyOut globals()['JsonApiIpAllowlistPolicyOutIncludes'] = JsonApiIpAllowlistPolicyOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiIpAllowlistPolicyOut,), # noqa: E501 'included': ([JsonApiIpAllowlistPolicyOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiIpAllowlistPolicyOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiIpAllowlistPolicyOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py index a2cc8ae54..e1d5112a5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_jwk_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_jwk_out_with_links import JsonApiJwkOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiJwkOutWithLinks'] = JsonApiJwkOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiJwkOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.py index 0a338ca37..c28e47adb 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_knowledge_recommendation_out import JsonApiKnowledgeRecommendationOut from gooddata_api_client.model.json_api_knowledge_recommendation_out_includes import JsonApiKnowledgeRecommendationOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiKnowledgeRecommendationOut'] = JsonApiKnowledgeRecommendationOut globals()['JsonApiKnowledgeRecommendationOutIncludes'] = JsonApiKnowledgeRecommendationOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiKnowledgeRecommendationOut,), # noqa: E501 'included': ([JsonApiKnowledgeRecommendationOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiKnowledgeRecommendationOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiKnowledgeRecommendationOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.py index 1c1e38b19..b305b0ae1 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_knowledge_recommendation_out_includes.py @@ -31,16 +31,16 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_analytical_dashboard_out_with_links import JsonApiAnalyticalDashboardOutWithLinks + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAnalyticalDashboardOutWithLinks'] = JsonApiAnalyticalDashboardOutWithLinks + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships globals()['JsonApiMetricOutAttributes'] = JsonApiMetricOutAttributes - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -106,8 +106,8 @@ def openapi_types(): """ lazy_import() return { - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 'attributes': (JsonApiMetricOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 @@ -167,8 +167,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiMetricOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 @@ -276,8 +276,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 attributes (JsonApiMetricOutAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py index 2c59a3a9f..acadd0622 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships @@ -103,7 +103,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 } @@ -166,7 +166,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 """ @@ -261,7 +261,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py index aaf3ad238..51bc5f074 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes.py @@ -31,8 +31,10 @@ def lazy_import(): + from gooddata_api_client.model.json_api_label_out_attributes_conditional_formatting import JsonApiLabelOutAttributesConditionalFormatting from gooddata_api_client.model.json_api_label_out_attributes_geo_area_config import JsonApiLabelOutAttributesGeoAreaConfig from gooddata_api_client.model.json_api_label_out_attributes_translations_inner import JsonApiLabelOutAttributesTranslationsInner + globals()['JsonApiLabelOutAttributesConditionalFormatting'] = JsonApiLabelOutAttributesConditionalFormatting globals()['JsonApiLabelOutAttributesGeoAreaConfig'] = JsonApiLabelOutAttributesGeoAreaConfig globals()['JsonApiLabelOutAttributesTranslationsInner'] = JsonApiLabelOutAttributesTranslationsInner @@ -121,6 +123,7 @@ def openapi_types(): lazy_import() return { 'are_relations_valid': (bool,), # noqa: E501 + 'conditional_formatting': (JsonApiLabelOutAttributesConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'geo_area_config': (JsonApiLabelOutAttributesGeoAreaConfig,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -143,6 +146,7 @@ def discriminator(): attribute_map = { 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'geo_area_config': 'geoAreaConfig', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -200,6 +204,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiLabelOutAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 geo_area_config (JsonApiLabelOutAttributesGeoAreaConfig): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -299,6 +304,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiLabelOutAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 geo_area_config (JsonApiLabelOutAttributesGeoAreaConfig): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes_conditional_formatting.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes_conditional_formatting.py new file mode 100644 index 000000000..0aa77e8af --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_attributes_conditional_formatting.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.conditional_formatting_condition import ConditionalFormattingCondition + globals()['ConditionalFormattingCondition'] = ConditionalFormattingCondition + + +class JsonApiLabelOutAttributesConditionalFormatting(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 = 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 { + 'conditions': ([ConditionalFormattingCondition],), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'conditions': 'conditions', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, conditions, enabled, *args, **kwargs): # noqa: E501 + """JsonApiLabelOutAttributesConditionalFormatting - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.conditions = conditions + self.enabled = enabled + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, conditions, enabled, *args, **kwargs): # noqa: E501 + """JsonApiLabelOutAttributesConditionalFormatting - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.conditions = conditions + self.enabled = enabled + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_label_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.py index e944d53aa..10a086520 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks globals()['JsonApiLabelOut'] = JsonApiLabelOut globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiLabelOut,), # noqa: E501 'included': ([JsonApiAttributeOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAttributeOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiAttributeOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py index bf71e00d4..f6171929c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_out_with_links.py @@ -31,13 +31,13 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta globals()['JsonApiLabelOut'] = JsonApiLabelOut globals()['JsonApiLabelOutAttributes'] = JsonApiLabelOutAttributes globals()['JsonApiLabelOutRelationships'] = JsonApiLabelOutRelationships @@ -109,7 +109,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 'attributes': (JsonApiLabelOutAttributes,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 'relationships': (JsonApiLabelOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -170,7 +170,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -280,7 +280,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiLabelOutAttributes): [optional] # noqa: E501 - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 relationships (JsonApiLabelOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.py index 23d3b6950..c4fb9a7cd 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_attribute_patch_attributes import JsonApiAttributePatchAttributes - globals()['JsonApiAttributePatchAttributes'] = JsonApiAttributePatchAttributes + from gooddata_api_client.model.json_api_label_patch_attributes import JsonApiLabelPatchAttributes + globals()['JsonApiLabelPatchAttributes'] = JsonApiLabelPatchAttributes class JsonApiLabelPatch(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiAttributePatchAttributes,), # noqa: E501 + 'attributes': (JsonApiLabelPatchAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiAttributePatchAttributes): [optional] # noqa: E501 + attributes (JsonApiLabelPatchAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "label") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiAttributePatchAttributes): [optional] # noqa: E501 + attributes (JsonApiLabelPatchAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "label") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_label_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch_attributes.py new file mode 100644 index 000000000..75e214551 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_label_patch_attributes.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.json_api_label_out_attributes_conditional_formatting import JsonApiLabelOutAttributesConditionalFormatting + globals()['JsonApiLabelOutAttributesConditionalFormatting'] = JsonApiLabelOutAttributesConditionalFormatting + + +class JsonApiLabelPatchAttributes(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 { + 'conditional_formatting': (JsonApiLabelOutAttributesConditionalFormatting,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiLabelPatchAttributes - 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,) + conditional_formatting (JsonApiLabelOutAttributesConditionalFormatting): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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 + """JsonApiLabelPatchAttributes - 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,) + conditional_formatting (JsonApiLabelOutAttributesConditionalFormatting): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.py index 24ff82fb9..dc3f9808e 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_llm_provider_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_llm_provider_out_with_links import JsonApiLlmProviderOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiLlmProviderOutWithLinks'] = JsonApiLlmProviderOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiLlmProviderOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.py index 67e771671..a59b5942c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_memory_item_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_memory_item_out import JsonApiMemoryItemOut 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()['JsonApiMemoryItemOut'] = JsonApiMemoryItemOut globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiMemoryItemOut,), # noqa: E501 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _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) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _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) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py index f28e2c35e..66fc0c1e7 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes.py @@ -31,8 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent - globals()['JsonApiMetricInAttributesContent'] = JsonApiMetricInAttributesContent + from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent + from gooddata_api_client.model.json_api_metric_in_attributes_conditional_formatting import JsonApiMetricInAttributesConditionalFormatting + globals()['JsonApiComputedAttributeInAttributesContent'] = JsonApiComputedAttributeInAttributesContent + globals()['JsonApiMetricInAttributesConditionalFormatting'] = JsonApiMetricInAttributesConditionalFormatting class JsonApiMetricInAttributes(ModelNormal): @@ -94,8 +96,9 @@ def openapi_types(): """ lazy_import() return { - 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 + 'content': (JsonApiComputedAttributeInAttributesContent,), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 + 'conditional_formatting': (JsonApiMetricInAttributesConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 'is_hidden_from_kda': (bool,), # noqa: E501 @@ -111,6 +114,7 @@ def discriminator(): attribute_map = { 'content': 'content', # noqa: E501 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 'is_hidden_from_kda': 'isHiddenFromKda', # noqa: E501 @@ -129,7 +133,7 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 """JsonApiMetricInAttributes - a model defined in OpenAPI Args: - content (JsonApiMetricInAttributesContent): + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -163,6 +167,7 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiMetricInAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 is_hidden_from_kda (bool): [optional] # noqa: E501 @@ -224,7 +229,7 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 """JsonApiMetricInAttributes - a model defined in OpenAPI Args: - content (JsonApiMetricInAttributesContent): + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -258,6 +263,7 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiMetricInAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 is_hidden_from_kda (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_conditional_formatting.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_conditional_formatting.py new file mode 100644 index 000000000..bc8723ffe --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_in_attributes_conditional_formatting.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.conditional_formatting_condition import ConditionalFormattingCondition + globals()['ConditionalFormattingCondition'] = ConditionalFormattingCondition + + +class JsonApiMetricInAttributesConditionalFormatting(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 = 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 { + 'conditions': ([ConditionalFormattingCondition],), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'conditions': 'conditions', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, conditions, enabled, *args, **kwargs): # noqa: E501 + """JsonApiMetricInAttributesConditionalFormatting - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.conditions = conditions + self.enabled = enabled + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, conditions, enabled, *args, **kwargs): # noqa: E501 + """JsonApiMetricInAttributesConditionalFormatting - a model defined in OpenAPI + + Args: + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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.conditions = conditions + self.enabled = enabled + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_metric_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.py index 7ff40e868..c793fcbd8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out.py @@ -31,12 +31,12 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships globals()['JsonApiMetricOutAttributes'] = JsonApiMetricOutAttributes - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships class JsonApiMetricOut(ModelNormal): @@ -103,8 +103,8 @@ def openapi_types(): 'attributes': (JsonApiMetricOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 } @cached_property @@ -166,8 +166,8 @@ def _from_openapi_data(cls, attributes, 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,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 """ type = kwargs.get('type', "metric") @@ -262,8 +262,8 @@ def __init__(self, attributes, 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,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 """ type = kwargs.get('type', "metric") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py index 50a691dde..1cee97d00 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_attributes.py @@ -31,8 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent - globals()['JsonApiMetricInAttributesContent'] = JsonApiMetricInAttributesContent + from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent + from gooddata_api_client.model.json_api_metric_in_attributes_conditional_formatting import JsonApiMetricInAttributesConditionalFormatting + globals()['JsonApiComputedAttributeInAttributesContent'] = JsonApiComputedAttributeInAttributesContent + globals()['JsonApiMetricInAttributesConditionalFormatting'] = JsonApiMetricInAttributesConditionalFormatting class JsonApiMetricOutAttributes(ModelNormal): @@ -112,11 +114,12 @@ def openapi_types(): """ lazy_import() return { - 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 + 'content': (JsonApiComputedAttributeInAttributesContent,), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 'certification': (str,), # noqa: E501 'certification_message': (str, none_type,), # noqa: E501 'certified_at': (datetime, none_type,), # noqa: E501 + 'conditional_formatting': (JsonApiMetricInAttributesConditionalFormatting,), # noqa: E501 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -137,6 +140,7 @@ def discriminator(): 'certification': 'certification', # noqa: E501 'certification_message': 'certificationMessage', # noqa: E501 'certified_at': 'certifiedAt', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -157,7 +161,7 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 """JsonApiMetricOutAttributes - a model defined in OpenAPI Args: - content (JsonApiMetricInAttributesContent): + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -194,6 +198,7 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (datetime, none_type): Time when the certification was set.. [optional] # noqa: E501 + conditional_formatting (JsonApiMetricInAttributesConditionalFormatting): [optional] # noqa: E501 created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -257,7 +262,7 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 """JsonApiMetricOutAttributes - a model defined in OpenAPI Args: - content (JsonApiMetricInAttributesContent): + content (JsonApiComputedAttributeInAttributesContent): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -294,6 +299,7 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (datetime, none_type): Time when the certification was set.. [optional] # noqa: E501 + conditional_formatting (JsonApiMetricInAttributesConditionalFormatting): [optional] # noqa: E501 created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py index 80593a1b9..9c1787958 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_document.py @@ -31,11 +31,13 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta + globals()['JsonApiComputedAttributeOutIncludes'] = JsonApiComputedAttributeOutIncludes globals()['JsonApiMetricOut'] = JsonApiMetricOut - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -95,8 +97,9 @@ def openapi_types(): lazy_import() return { 'data': (JsonApiMetricOut,), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiComputedAttributeOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -154,8 +158,9 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -245,8 +250,9 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py index 8af24f41d..239e12fac 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_list.py @@ -32,11 +32,11 @@ def lazy_import(): from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes + from gooddata_api_client.model.json_api_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks from gooddata_api_client.model.list_links import ListLinks globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes + globals()['JsonApiComputedAttributeOutIncludes'] = JsonApiComputedAttributeOutIncludes globals()['JsonApiMetricOutWithLinks'] = JsonApiMetricOutWithLinks globals()['ListLinks'] = ListLinks @@ -99,7 +99,7 @@ def openapi_types(): lazy_import() return { 'data': ([JsonApiMetricOutWithLinks],), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiComputedAttributeOutIncludes],), # noqa: E501 'links': (ListLinks,), # noqa: E501 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 } @@ -160,7 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 """ @@ -252,7 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py index 97b662ae5..a771c4cb8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_out_with_links.py @@ -31,16 +31,16 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships globals()['JsonApiMetricOut'] = JsonApiMetricOut globals()['JsonApiMetricOutAttributes'] = JsonApiMetricOutAttributes - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -109,8 +109,8 @@ def openapi_types(): 'attributes': (JsonApiMetricOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -170,8 +170,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -280,8 +280,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py index 84714ed0a..e38310bb0 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_metric_patch_attributes.py @@ -31,8 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent - globals()['JsonApiMetricInAttributesContent'] = JsonApiMetricInAttributesContent + from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent + from gooddata_api_client.model.json_api_metric_in_attributes_conditional_formatting import JsonApiMetricInAttributesConditionalFormatting + globals()['JsonApiComputedAttributeInAttributesContent'] = JsonApiComputedAttributeInAttributesContent + globals()['JsonApiMetricInAttributesConditionalFormatting'] = JsonApiMetricInAttributesConditionalFormatting class JsonApiMetricPatchAttributes(ModelNormal): @@ -95,7 +97,8 @@ def openapi_types(): lazy_import() return { 'are_relations_valid': (bool,), # noqa: E501 - 'content': (JsonApiMetricInAttributesContent,), # noqa: E501 + 'conditional_formatting': (JsonApiMetricInAttributesConditionalFormatting,), # noqa: E501 + 'content': (JsonApiComputedAttributeInAttributesContent,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 'is_hidden_from_kda': (bool,), # noqa: E501 @@ -110,6 +113,7 @@ def discriminator(): attribute_map = { 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'content': 'content', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -160,7 +164,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - content (JsonApiMetricInAttributesContent): [optional] # noqa: E501 + conditional_formatting (JsonApiMetricInAttributesConditionalFormatting): [optional] # noqa: E501 + content (JsonApiComputedAttributeInAttributesContent): [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 is_hidden_from_kda (bool): [optional] # noqa: E501 @@ -252,7 +257,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 - content (JsonApiMetricInAttributesContent): [optional] # noqa: E501 + conditional_formatting (JsonApiMetricInAttributesConditionalFormatting): [optional] # noqa: E501 + content (JsonApiComputedAttributeInAttributesContent): [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 is_hidden_from_kda (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py index 03c93c70d..8ee8cb8e8 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_identifier_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_notification_channel_identifier_out_with_links import JsonApiNotificationChannelIdentifierOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiNotificationChannelIdentifierOutWithLinks'] = JsonApiNotificationChannelIdentifierOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiNotificationChannelIdentifierOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py index 6fa325086..43a77ec88 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_notification_channel_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_notification_channel_out_with_links import JsonApiNotificationChannelOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiNotificationChannelOutWithLinks'] = JsonApiNotificationChannelOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiNotificationChannelOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_document.py index a8c9fb9e7..8f14e89d5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_org_memory_item_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_org_memory_item_out import JsonApiOrgMemoryItemOut from gooddata_api_client.model.json_api_user_identifier_out_with_links import JsonApiUserIdentifierOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiOrgMemoryItemOut'] = JsonApiOrgMemoryItemOut globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiOrgMemoryItemOut,), # noqa: E501 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _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) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _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) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py index 14d3ebd89..d77201601 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_organization_out import JsonApiOrganizationOut from gooddata_api_client.model.json_api_organization_out_includes import JsonApiOrganizationOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiOrganizationOut'] = JsonApiOrganizationOut globals()['JsonApiOrganizationOutIncludes'] = JsonApiOrganizationOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiOrganizationOut,), # noqa: E501 'included': ([JsonApiOrganizationOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiOrganizationOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiOrganizationOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py index 5621ea851..a5bb095f2 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_in_attributes.py @@ -98,10 +98,12 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'LDM_DEFAULT_LOCALE': "LDM_DEFAULT_LOCALE", 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", + 'CONVERSATION_RETENTION_DAYS': "CONVERSATION_RETENTION_DAYS", 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", 'SORT_COLLATION': "SORT_COLLATION", 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", + 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", @@ -110,6 +112,11 @@ class JsonApiOrganizationSettingInAttributes(ModelNormal): 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", 'CERTIFY_PARENT_OBJECTS': "CERTIFY_PARENT_OBJECTS", 'HLL_TYPE': "HLL_TYPE", + 'ENABLE_TIMEZONE_CHANGE': "ENABLE_TIMEZONE_CHANGE", + 'AUTHORIZATION_SERVER_REDIRECT_POLICY': "AUTHORIZATION_SERVER_REDIRECT_POLICY", + 'DEFAULT_VISUALIZATION_VISIBILITY': "DEFAULT_VISUALIZATION_VISIBILITY", + 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", + 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py index f4c71f095..2c0becd22 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_organization_setting_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_organization_setting_out_with_links import JsonApiOrganizationSettingOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiOrganizationSettingOutWithLinks'] = JsonApiOrganizationSettingOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiOrganizationSettingOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_parameter_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_parameter_out_document.py index 10770dbf8..557ec8f3c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_parameter_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_parameter_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_parameter_out import JsonApiParameterOut 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()['JsonApiParameterOut'] = JsonApiParameterOut globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiParameterOut,), # noqa: E501 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _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) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _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) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_item_pipe_table_summary.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_in.py similarity index 90% rename from gooddata-api-client/gooddata_api_client/model/json_api_item_pipe_table_summary.py rename to gooddata-api-client/gooddata_api_client/model/json_api_report_in.py index 8003c213a..3332d3710 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_item_pipe_table_summary.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_in.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.pipe_table_summary import PipeTableSummary - globals()['PipeTableSummary'] = PipeTableSummary + from gooddata_api_client.model.json_api_report_in_attributes import JsonApiReportInAttributes + globals()['JsonApiReportInAttributes'] = JsonApiReportInAttributes -class JsonApiItemPipeTableSummary(ModelNormal): +class JsonApiReportIn(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -60,9 +60,17 @@ class JsonApiItemPipeTableSummary(ModelNormal): """ allowed_values = { + ('type',): { + 'REPORT': "report", + }, } validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, } @cached_property @@ -88,7 +96,7 @@ def openapi_types(): """ lazy_import() return { - 'attributes': (PipeTableSummary,), # noqa: E501 + 'attributes': (JsonApiReportInAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -111,15 +119,15 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attributes, id, type, *args, **kwargs): # noqa: E501 - """JsonApiItemPipeTableSummary - a model defined in OpenAPI + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiReportIn - a model defined in OpenAPI Args: - attributes (PipeTableSummary): - id (str): Resource identifier - type (str): Resource type + attributes (JsonApiReportInAttributes): + id (str): API identifier of an object Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # 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,6 +160,7 @@ def _from_openapi_data(cls, attributes, id, type, *args, **kwargs): # noqa: E50 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "report") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -204,15 +213,15 @@ def _from_openapi_data(cls, attributes, id, type, *args, **kwargs): # noqa: E50 ]) @convert_js_args_to_python_args - def __init__(self, attributes, id, type, *args, **kwargs): # noqa: E501 - """JsonApiItemPipeTableSummary - a model defined in OpenAPI + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiReportIn - a model defined in OpenAPI Args: - attributes (PipeTableSummary): - id (str): Resource identifier - type (str): Resource type + attributes (JsonApiReportInAttributes): + id (str): API identifier of an object Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # 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. @@ -245,6 +254,7 @@ def __init__(self, attributes, id, type, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ + type = kwargs.get('type', "report") _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/json_api_report_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_in_attributes.py new file mode 100644 index 000000000..aebba4a09 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_in_attributes.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 + + + +class JsonApiReportInAttributes(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 + """ + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'period_end': (date,), # noqa: E501 + 'period_start': (date,), # noqa: E501 + 'title': (str,), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'variable_values': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'period_end': 'periodEnd', # noqa: E501 + 'period_start': 'periodStart', # noqa: E501 + 'title': 'title', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'variable_values': 'variableValues', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, period_end, period_start, title, *args, **kwargs): # noqa: E501 + """JsonApiReportInAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + period_end (date): Last day of the reported period, inclusive. + period_start (date): First day of the reported period, inclusive. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + are_relations_valid (bool): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + variable_values (bool, date, datetime, dict, float, int, list, str, none_type): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.content = content + self.period_end = period_end + self.period_start = period_start + self.title = title + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, content, period_end, period_start, title, *args, **kwargs): # noqa: E501 + """JsonApiReportInAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + period_end (date): Last day of the reported period, inclusive. + period_start (date): First day of the reported period, inclusive. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + are_relations_valid (bool): [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + variable_values (bool, date, datetime, dict, float, int, list, str, none_type): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.content = content + self.period_end = period_end + self.period_start = period_start + self.title = title + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_in_document.py new file mode 100644 index 000000000..8d34d3902 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_in import JsonApiReportIn + globals()['JsonApiReportIn'] = JsonApiReportIn + + +class JsonApiReportInDocument(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': (JsonApiReportIn,), # 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 + """JsonApiReportInDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportInDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_out.py new file mode 100644 index 000000000..1b493d47d --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_out_attributes import JsonApiReportOutAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiReportOutAttributes'] = JsonApiReportOutAttributes + + +class JsonApiReportOut(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',): { + 'REPORT': "report", + }, + } + + 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': (JsonApiReportOutAttributes,), # 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 + """JsonApiReportOut - a model defined in OpenAPI + + Args: + attributes (JsonApiReportOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # 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', "report") + _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 + """JsonApiReportOut - a model defined in OpenAPI + + Args: + attributes (JsonApiReportOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # 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', "report") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_attributes.py new file mode 100644 index 000000000..150302cc3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_attributes.py @@ -0,0 +1,328 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + 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 JsonApiReportOutAttributes(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 + """ + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'period_end': (date,), # noqa: E501 + 'period_start': (date,), # noqa: E501 + 'title': (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 + 'variable_values': (bool, date, datetime, dict, float, int, list, str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # noqa: E501 + 'period_end': 'periodEnd', # noqa: E501 + 'period_start': 'periodStart', # noqa: E501 + 'title': 'title', # 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 + 'variable_values': 'variableValues', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, content, period_end, period_start, title, *args, **kwargs): # noqa: E501 + """JsonApiReportOutAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + period_end (date): Last day of the reported period, inclusive. + period_start (date): First day of the reported period, inclusive. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + variable_values (bool, date, datetime, dict, float, int, list, str, none_type): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.content = content + self.period_end = period_end + self.period_start = period_start + self.title = title + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, content, period_end, period_start, title, *args, **kwargs): # noqa: E501 + """JsonApiReportOutAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + period_end (date): Last day of the reported period, inclusive. + period_start (date): First day of the reported period, inclusive. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + variable_values (bool, date, datetime, dict, float, int, list, str, none_type): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.content = content + self.period_end = period_end + self.period_start = period_start + self.title = title + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/object_reference_group.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_document.py similarity index 85% rename from gooddata-api-client/gooddata_api_client/model/object_reference_group.py rename to gooddata-api-client/gooddata_api_client/model/json_api_report_out_document.py index 498d76634..3df517d78 100644 --- a/gooddata-api-client/gooddata_api_client/model/object_reference_group.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_document.py @@ -31,11 +31,17 @@ def lazy_import(): - from gooddata_api_client.model.object_reference import ObjectReference - globals()['ObjectReference'] = ObjectReference + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_report_out import JsonApiReportOut + 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()['JsonApiReportOut'] = JsonApiReportOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks -class ObjectReferenceGroup(ModelNormal): +class JsonApiReportOutDocument(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -63,6 +69,8 @@ class ObjectReferenceGroup(ModelNormal): } validations = { + ('included',): { + }, } @cached_property @@ -88,8 +96,10 @@ def openapi_types(): """ lazy_import() return { - 'objects': ([ObjectReference],), # noqa: E501 - 'context': (ObjectReference,), # noqa: E501 + 'data': (JsonApiReportOut,), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -98,8 +108,10 @@ def discriminator(): attribute_map = { - 'objects': 'objects', # noqa: E501 - 'context': 'context', # noqa: E501 + 'data': 'data', # noqa: E501 + 'included': 'included', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -109,11 +121,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, objects, *args, **kwargs): # noqa: E501 - """ObjectReferenceGroup - a model defined in OpenAPI + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiReportOutDocument - a model defined in OpenAPI Args: - objects ([ObjectReference]): Objects the user explicitly referenced within this context. + data (JsonApiReportOut): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -146,7 +158,9 @@ def _from_openapi_data(cls, objects, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - context (ObjectReference): [optional] # noqa: E501 + included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -178,7 +192,7 @@ def _from_openapi_data(cls, objects, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.objects = objects + 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 \ @@ -199,11 +213,11 @@ def _from_openapi_data(cls, objects, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, objects, *args, **kwargs): # noqa: E501 - """ObjectReferenceGroup - a model defined in OpenAPI + def __init__(self, data, *args, **kwargs): # noqa: E501 + """JsonApiReportOutDocument - a model defined in OpenAPI Args: - objects ([ObjectReference]): Objects the user explicitly referenced within this context. + data (JsonApiReportOut): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -236,7 +250,9 @@ def __init__(self, objects, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - context (ObjectReference): [optional] # noqa: E501 + included ([JsonApiUserIdentifierOutWithLinks]): Included resources. [optional] # noqa: E501 + links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -266,7 +282,7 @@ def __init__(self, objects, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.objects = objects + 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/pipe_table_summary.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_list.py similarity index 84% rename from gooddata-api-client/gooddata_api_client/model/pipe_table_summary.py rename to gooddata-api-client/gooddata_api_client/model/json_api_report_out_list.py index d691f1ac7..fc903a3d6 100644 --- a/gooddata-api-client/gooddata_api_client/model/pipe_table_summary.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_list.py @@ -31,11 +31,17 @@ def lazy_import(): - from gooddata_api_client.model.column_info import ColumnInfo - globals()['ColumnInfo'] = ColumnInfo + from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_report_out_with_links import JsonApiReportOutWithLinks + 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()['JsonApiReportOutWithLinks'] = JsonApiReportOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks -class PipeTableSummary(ModelNormal): +class JsonApiReportOutList(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -63,6 +69,10 @@ class PipeTableSummary(ModelNormal): } validations = { + ('data',): { + }, + ('included',): { + }, } @cached_property @@ -88,10 +98,10 @@ def openapi_types(): """ lazy_import() return { - 'columns': ([ColumnInfo],), # noqa: E501 - 'path_prefix': (str,), # noqa: E501 - 'pipe_table_id': (str,), # noqa: E501 - 'table_name': (str,), # noqa: E501 + 'data': ([JsonApiReportOutWithLinks],), # noqa: E501 + 'included': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 + 'links': (ListLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 } @cached_property @@ -100,10 +110,10 @@ def discriminator(): attribute_map = { - 'columns': 'columns', # noqa: E501 - 'path_prefix': 'pathPrefix', # noqa: E501 - 'pipe_table_id': 'pipeTableId', # noqa: E501 - 'table_name': 'tableName', # noqa: E501 + 'data': 'data', # noqa: E501 + 'included': 'included', # noqa: E501 + 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -113,14 +123,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, path_prefix, pipe_table_id, table_name, *args, **kwargs): # noqa: E501 - """PipeTableSummary - a model defined in OpenAPI + def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 + """JsonApiReportOutList - a model defined in OpenAPI Args: - columns ([ColumnInfo]): Inferred column schema - path_prefix (str): Path prefix to the parquet files - pipe_table_id (str): Internal UUID of the pipe table record - table_name (str): OLAP table name + data ([JsonApiReportOutWithLinks]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -153,6 +160,9 @@ def _from_openapi_data(cls, columns, path_prefix, pipe_table_id, table_name, *ar 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) @@ -184,10 +194,7 @@ def _from_openapi_data(cls, columns, path_prefix, pipe_table_id, table_name, *ar self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.columns = columns - self.path_prefix = path_prefix - self.pipe_table_id = pipe_table_id - self.table_name = table_name + 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 \ @@ -208,14 +215,11 @@ def _from_openapi_data(cls, columns, path_prefix, pipe_table_id, table_name, *ar ]) @convert_js_args_to_python_args - def __init__(self, columns, path_prefix, pipe_table_id, table_name, *args, **kwargs): # noqa: E501 - """PipeTableSummary - a model defined in OpenAPI + def __init__(self, data, *args, **kwargs): # noqa: E501 + """JsonApiReportOutList - a model defined in OpenAPI Args: - columns ([ColumnInfo]): Inferred column schema - path_prefix (str): Path prefix to the parquet files - pipe_table_id (str): Internal UUID of the pipe table record - table_name (str): OLAP table name + data ([JsonApiReportOutWithLinks]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -248,6 +252,9 @@ def __init__(self, columns, path_prefix, pipe_table_id, table_name, *args, **kwa 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) @@ -277,10 +284,7 @@ def __init__(self, columns, path_prefix, pipe_table_id, table_name, *args, **kwa self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.columns = columns - self.path_prefix = path_prefix - self.pipe_table_id = pipe_table_id - self.table_name = table_name + 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 \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_out_with_links.py new file mode 100644 index 000000000..cb1fb8413 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_out import JsonApiReportOut + from gooddata_api_client.model.json_api_report_out_attributes import JsonApiReportOutAttributes + 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()['JsonApiReportOut'] = JsonApiReportOut + globals()['JsonApiReportOutAttributes'] = JsonApiReportOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiReportOutWithLinks(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',): { + 'REPORT': "report", + }, + } + + 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': (JsonApiReportOutAttributes,), # 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 + """JsonApiReportOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiReportOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "report", must be one of ["report", ] # 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', "report") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiReportOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiReportOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "report", must be one of ["report", ] # 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', "report") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiReportOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in.py new file mode 100644 index 000000000..ea86760f3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_in_attributes import JsonApiReportPageLayoutInAttributes + globals()['JsonApiReportPageLayoutInAttributes'] = JsonApiReportPageLayoutInAttributes + + +class JsonApiReportPageLayoutIn(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',): { + 'REPORTPAGELAYOUT': "reportPageLayout", + }, + } + + 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': (JsonApiReportPageLayoutInAttributes,), # 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 + """JsonApiReportPageLayoutIn - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _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 + """JsonApiReportPageLayoutIn - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_page_layout_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in_attributes.py new file mode 100644 index 000000000..0984a0702 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in_attributes.py @@ -0,0 +1,294 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiReportPageLayoutInAttributes(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 + """ + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'title': (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 + '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, *args, **kwargs): # noqa: E501 + """JsonApiReportPageLayoutInAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, *args, **kwargs): # noqa: E501 + """JsonApiReportPageLayoutInAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_page_layout_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_in_document.py new file mode 100644 index 000000000..2361f739a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_in import JsonApiReportPageLayoutIn + globals()['JsonApiReportPageLayoutIn'] = JsonApiReportPageLayoutIn + + +class JsonApiReportPageLayoutInDocument(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': (JsonApiReportPageLayoutIn,), # 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 + """JsonApiReportPageLayoutInDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPageLayoutInDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_page_layout_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out.py new file mode 100644 index 000000000..f0a0f3296 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_out_attributes import JsonApiReportPageLayoutOutAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiReportPageLayoutOutAttributes'] = JsonApiReportPageLayoutOutAttributes + + +class JsonApiReportPageLayoutOut(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',): { + 'REPORTPAGELAYOUT': "reportPageLayout", + }, + } + + 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': (JsonApiReportPageLayoutOutAttributes,), # 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 + """JsonApiReportPageLayoutOut - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _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 + """JsonApiReportPageLayoutOut - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_page_layout_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_attributes.py new file mode 100644 index 000000000..5f5312349 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_attributes.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 + + + +class JsonApiReportPageLayoutOutAttributes(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 + """ + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'title': (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 + '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, *args, **kwargs): # noqa: E501 + """JsonApiReportPageLayoutOutAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, *args, **kwargs): # noqa: E501 + """JsonApiReportPageLayoutOutAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_page_layout_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_document.py new file mode 100644 index 000000000..7cb73e567 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_out import JsonApiReportPageLayoutOut + 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()['JsonApiReportPageLayoutOut'] = JsonApiReportPageLayoutOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiReportPageLayoutOutDocument(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': (JsonApiReportPageLayoutOut,), # 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 + """JsonApiReportPageLayoutOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPageLayoutOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_page_layout_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_list.py new file mode 100644 index 000000000..603c8b1d9 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_out_with_links import JsonApiReportPageLayoutOutWithLinks + 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()['JsonApiReportPageLayoutOutWithLinks'] = JsonApiReportPageLayoutOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiReportPageLayoutOutList(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': ([JsonApiReportPageLayoutOutWithLinks],), # 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 + """JsonApiReportPageLayoutOutList - a model defined in OpenAPI + + Args: + data ([JsonApiReportPageLayoutOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPageLayoutOutList - a model defined in OpenAPI + + Args: + data ([JsonApiReportPageLayoutOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_page_layout_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_out_with_links.py new file mode 100644 index 000000000..785af74c0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_out import JsonApiReportPageLayoutOut + from gooddata_api_client.model.json_api_report_page_layout_out_attributes import JsonApiReportPageLayoutOutAttributes + 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()['JsonApiReportPageLayoutOut'] = JsonApiReportPageLayoutOut + globals()['JsonApiReportPageLayoutOutAttributes'] = JsonApiReportPageLayoutOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiReportPageLayoutOutWithLinks(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',): { + 'REPORTPAGELAYOUT': "reportPageLayout", + }, + } + + 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': (JsonApiReportPageLayoutOutAttributes,), # 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 + """JsonApiReportPageLayoutOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiReportPageLayoutOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiReportPageLayoutOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiReportPageLayoutOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiReportPageLayoutOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch.py new file mode 100644 index 000000000..35c04629a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_patch_attributes import JsonApiReportPageLayoutPatchAttributes + globals()['JsonApiReportPageLayoutPatchAttributes'] = JsonApiReportPageLayoutPatchAttributes + + +class JsonApiReportPageLayoutPatch(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',): { + 'REPORTPAGELAYOUT': "reportPageLayout", + }, + } + + 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': (JsonApiReportPageLayoutPatchAttributes,), # 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 + """JsonApiReportPageLayoutPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _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 + """JsonApiReportPageLayoutPatch - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutPatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_page_layout_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch_attributes.py new file mode 100644 index 000000000..190009028 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch_attributes.py @@ -0,0 +1,286 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiReportPageLayoutPatchAttributes(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 + """ + 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 { + 'are_relations_valid': (bool,), # noqa: E501 + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (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 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiReportPageLayoutPatchAttributes - 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 ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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 + """JsonApiReportPageLayoutPatchAttributes - 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 ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form page definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_page_layout_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_patch_document.py new file mode 100644 index 000000000..dcafc7004 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_patch import JsonApiReportPageLayoutPatch + globals()['JsonApiReportPageLayoutPatch'] = JsonApiReportPageLayoutPatch + + +class JsonApiReportPageLayoutPatchDocument(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': (JsonApiReportPageLayoutPatch,), # 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 + """JsonApiReportPageLayoutPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutPatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPageLayoutPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutPatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_page_layout_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_post_optional_id.py new file mode 100644 index 000000000..69ddc02ea --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_in_attributes import JsonApiReportPageLayoutInAttributes + globals()['JsonApiReportPageLayoutInAttributes'] = JsonApiReportPageLayoutInAttributes + + +class JsonApiReportPageLayoutPostOptionalId(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',): { + 'REPORTPAGELAYOUT': "reportPageLayout", + }, + } + + 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': (JsonApiReportPageLayoutInAttributes,), # 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 + """JsonApiReportPageLayoutPostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutInAttributes): + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _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 + """JsonApiReportPageLayoutPostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiReportPageLayoutInAttributes): + + Keyword Args: + type (str): Object type. defaults to "reportPageLayout", must be one of ["reportPageLayout", ] # 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', "reportPageLayout") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_page_layout_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_post_optional_id_document.py new file mode 100644 index 000000000..6c4abb034 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_page_layout_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_report_page_layout_post_optional_id import JsonApiReportPageLayoutPostOptionalId + globals()['JsonApiReportPageLayoutPostOptionalId'] = JsonApiReportPageLayoutPostOptionalId + + +class JsonApiReportPageLayoutPostOptionalIdDocument(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': (JsonApiReportPageLayoutPostOptionalId,), # 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 + """JsonApiReportPageLayoutPostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutPostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPageLayoutPostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPageLayoutPostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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/metric.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_patch.py similarity index 88% rename from gooddata-api-client/gooddata_api_client/model/metric.py rename to gooddata-api-client/gooddata_api_client/model/json_api_report_patch.py index 69df26fe1..050dba4e9 100644 --- a/gooddata-api-client/gooddata_api_client/model/metric.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_patch.py @@ -30,8 +30,12 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_report_patch_attributes import JsonApiReportPatchAttributes + globals()['JsonApiReportPatchAttributes'] = JsonApiReportPatchAttributes -class Metric(ModelNormal): + +class JsonApiReportPatch(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,21 +61,16 @@ class Metric(ModelNormal): allowed_values = { ('type',): { - 'METRIC': "metric", - 'FACT': "fact", - 'ATTRIBUTE': "attribute", - }, - ('agg_function',): { - 'COUNT': "COUNT", - 'SUM': "SUM", - 'MIN': "MIN", - 'MAX': "MAX", - 'AVG': "AVG", - 'MEDIAN': "MEDIAN", + 'REPORT': "report", }, } validations = { + ('id',): { + 'regex': { + 'pattern': r'^(?!\.)[.A-Za-z0-9_-]{1,255}$', # noqa: E501 + }, + }, } @cached_property @@ -80,6 +79,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -94,11 +94,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { + 'attributes': (JsonApiReportPatchAttributes,), # noqa: E501 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'agg_function': (str,), # noqa: E501 } @cached_property @@ -107,10 +107,9 @@ def discriminator(): attribute_map = { + 'attributes': 'attributes', # noqa: E501 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 'type': 'type', # noqa: E501 - 'agg_function': 'aggFunction', # noqa: E501 } read_only_vars = { @@ -120,15 +119,15 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, type, *args, **kwargs): # noqa: E501 - """Metric - a model defined in OpenAPI + def _from_openapi_data(cls, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiReportPatch - a model defined in OpenAPI Args: - id (str): ID of the object - title (str): Title of metric. - type (str): Object type + attributes (JsonApiReportPatchAttributes): + id (str): API identifier of an object Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -159,9 +158,9 @@ def _from_openapi_data(cls, id, title, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - agg_function (str): Agg function. Empty if a stored metric is used.. [optional] # noqa: E501 """ + type = kwargs.get('type', "report") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -191,8 +190,8 @@ def _from_openapi_data(cls, id, title, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.attributes = attributes self.id = id - self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -214,15 +213,15 @@ def _from_openapi_data(cls, id, title, type, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, title, type, *args, **kwargs): # noqa: E501 - """Metric - a model defined in OpenAPI + def __init__(self, attributes, id, *args, **kwargs): # noqa: E501 + """JsonApiReportPatch - a model defined in OpenAPI Args: - id (str): ID of the object - title (str): Title of metric. - type (str): Object type + attributes (JsonApiReportPatchAttributes): + id (str): API identifier of an object Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -253,9 +252,9 @@ def __init__(self, id, title, type, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - agg_function (str): Agg function. Empty if a stored metric is used.. [optional] # noqa: E501 """ + type = kwargs.get('type', "report") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -283,8 +282,8 @@ def __init__(self, id, title, type, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + self.attributes = attributes self.id = id - self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_patch_attributes.py new file mode 100644 index 000000000..a41ca8c72 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_patch_attributes.py @@ -0,0 +1,298 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiReportPatchAttributes(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 + """ + 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 { + 'are_relations_valid': (bool,), # noqa: E501 + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'description': (str,), # noqa: E501 + 'period_end': (date,), # noqa: E501 + 'period_start': (date,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 + 'variable_values': (bool, date, datetime, dict, float, int, list, str, none_type,), # 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_end': 'periodEnd', # noqa: E501 + 'period_start': 'periodStart', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 + 'variable_values': 'variableValues', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """JsonApiReportPatchAttributes - 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 ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + period_end (date): Last day of the reported period, inclusive.. [optional] # noqa: E501 + period_start (date): First day of the reported period, inclusive.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + variable_values (bool, date, datetime, dict, float, int, list, str, none_type): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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 + """JsonApiReportPatchAttributes - 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 ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form report definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + period_end (date): Last day of the reported period, inclusive.. [optional] # noqa: E501 + period_start (date): First day of the reported period, inclusive.. [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 + variable_values (bool, date, datetime, dict, float, int, list, str, none_type): Values for the variables declared in the content, keyed by name.. [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_patch_document.py new file mode 100644 index 000000000..e126243a2 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_patch import JsonApiReportPatch + globals()['JsonApiReportPatch'] = JsonApiReportPatch + + +class JsonApiReportPatchDocument(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': (JsonApiReportPatch,), # 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 + """JsonApiReportPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_post_optional_id.py new file mode 100644 index 000000000..511ebbc43 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_in_attributes import JsonApiReportInAttributes + globals()['JsonApiReportInAttributes'] = JsonApiReportInAttributes + + +class JsonApiReportPostOptionalId(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',): { + 'REPORT': "report", + }, + } + + 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': (JsonApiReportInAttributes,), # 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 + """JsonApiReportPostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiReportInAttributes): + + Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # 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', "report") + _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 + """JsonApiReportPostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiReportInAttributes): + + Keyword Args: + type (str): Object type. defaults to "report", must be one of ["report", ] # 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', "report") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_post_optional_id_document.py new file mode 100644 index 000000000..60ba40350 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_post_optional_id import JsonApiReportPostOptionalId + globals()['JsonApiReportPostOptionalId'] = JsonApiReportPostOptionalId + + +class JsonApiReportPostOptionalIdDocument(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': (JsonApiReportPostOptionalId,), # 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 + """JsonApiReportPostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportPostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportPostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_template_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_in.py new file mode 100644 index 000000000..150cd1a4e --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_in_attributes import JsonApiReportTemplateInAttributes + globals()['JsonApiReportTemplateInAttributes'] = JsonApiReportTemplateInAttributes + + +class JsonApiReportTemplateIn(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',): { + 'REPORTTEMPLATE': "reportTemplate", + }, + } + + 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': (JsonApiReportTemplateInAttributes,), # 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 + """JsonApiReportTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _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 + """JsonApiReportTemplateIn - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplateInAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_template_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_in_attributes.py new file mode 100644 index 000000000..dbc88a76b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_in_attributes.py @@ -0,0 +1,294 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + + +class JsonApiReportTemplateInAttributes(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 + """ + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'title': (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 + '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, *args, **kwargs): # noqa: E501 + """JsonApiReportTemplateInAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, *args, **kwargs): # noqa: E501 + """JsonApiReportTemplateInAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_template_in_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_in_document.py new file mode 100644 index 000000000..58cfc9106 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_in import JsonApiReportTemplateIn + globals()['JsonApiReportTemplateIn'] = JsonApiReportTemplateIn + + +class JsonApiReportTemplateInDocument(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': (JsonApiReportTemplateIn,), # 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 + """JsonApiReportTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplateIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportTemplateInDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplateIn): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_template_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_out.py new file mode 100644 index 000000000..d022f48a0 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_out_attributes import JsonApiReportTemplateOutAttributes + globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta + globals()['JsonApiDashboardPluginOutRelationships'] = JsonApiDashboardPluginOutRelationships + globals()['JsonApiReportTemplateOutAttributes'] = JsonApiReportTemplateOutAttributes + + +class JsonApiReportTemplateOut(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',): { + 'REPORTTEMPLATE': "reportTemplate", + }, + } + + 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': (JsonApiReportTemplateOutAttributes,), # 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 + """JsonApiReportTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplateOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _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 + """JsonApiReportTemplateOut - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplateOutAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_template_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_attributes.py new file mode 100644 index 000000000..0a5f24edf --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_attributes.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 + + + +class JsonApiReportTemplateOutAttributes(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 + """ + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'title': (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 + '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, *args, **kwargs): # noqa: E501 + """JsonApiReportTemplateOutAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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, *args, **kwargs): # noqa: E501 + """JsonApiReportTemplateOutAttributes - a model defined in OpenAPI + + Args: + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters. + title (str): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + 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 + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_report_template_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_document.py new file mode 100644 index 000000000..699635f91 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_out import JsonApiReportTemplateOut + 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()['JsonApiReportTemplateOut'] = JsonApiReportTemplateOut + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ObjectLinks'] = ObjectLinks + + +class JsonApiReportTemplateOutDocument(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': (JsonApiReportTemplateOut,), # 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 + """JsonApiReportTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplateOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportTemplateOutDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplateOut): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_list.py new file mode 100644 index 000000000..2f20f2ddc --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_out_with_links import JsonApiReportTemplateOutWithLinks + 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()['JsonApiReportTemplateOutWithLinks'] = JsonApiReportTemplateOutWithLinks + globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks + globals()['ListLinks'] = ListLinks + + +class JsonApiReportTemplateOutList(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': ([JsonApiReportTemplateOutWithLinks],), # 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 + """JsonApiReportTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiReportTemplateOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportTemplateOutList - a model defined in OpenAPI + + Args: + data ([JsonApiReportTemplateOutWithLinks]): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_template_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_out_with_links.py new file mode 100644 index 000000000..ab96e729a --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_out import JsonApiReportTemplateOut + from gooddata_api_client.model.json_api_report_template_out_attributes import JsonApiReportTemplateOutAttributes + 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()['JsonApiReportTemplateOut'] = JsonApiReportTemplateOut + globals()['JsonApiReportTemplateOutAttributes'] = JsonApiReportTemplateOutAttributes + globals()['ObjectLinks'] = ObjectLinks + globals()['ObjectLinksContainer'] = ObjectLinksContainer + + +class JsonApiReportTemplateOutWithLinks(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',): { + 'REPORTTEMPLATE': "reportTemplate", + }, + } + + 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': (JsonApiReportTemplateOutAttributes,), # 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 + """JsonApiReportTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiReportTemplateOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_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 + """JsonApiReportTemplateOutWithLinks - a model defined in OpenAPI + + Keyword Args: + attributes (JsonApiReportTemplateOutAttributes): + id (str): API identifier of an object + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_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': [ + JsonApiReportTemplateOut, + ObjectLinksContainer, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch.py new file mode 100644 index 000000000..0962e2167 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_patch_attributes import JsonApiReportTemplatePatchAttributes + globals()['JsonApiReportTemplatePatchAttributes'] = JsonApiReportTemplatePatchAttributes + + +class JsonApiReportTemplatePatch(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',): { + 'REPORTTEMPLATE': "reportTemplate", + }, + } + + 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': (JsonApiReportTemplatePatchAttributes,), # 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 + """JsonApiReportTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _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 + """JsonApiReportTemplatePatch - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplatePatchAttributes): + id (str): API identifier of an object + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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/hash_distribution_config.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch_attributes.py similarity index 86% rename from gooddata-api-client/gooddata_api_client/model/hash_distribution_config.py rename to gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch_attributes.py index f7605a7f7..dcb5f8835 100644 --- a/gooddata-api-client/gooddata_api_client/model/hash_distribution_config.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch_attributes.py @@ -31,7 +31,7 @@ -class HashDistributionConfig(ModelNormal): +class JsonApiReportTemplatePatchAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,14 +56,14 @@ class HashDistributionConfig(ModelNormal): """ allowed_values = { - ('type',): { - 'HASH': "hash", - }, } validations = { - ('buckets',): { - 'inclusive_minimum': 1, + ('description',): { + 'max_length': 10000, + }, + ('title',): { + 'max_length': 255, }, } @@ -88,9 +88,11 @@ def openapi_types(): and the value is attribute type. """ return { - 'type': (str,), # noqa: E501 - 'buckets': (int,), # noqa: E501 - 'columns': ([str],), # noqa: E501 + 'are_relations_valid': (bool,), # noqa: E501 + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'description': (str,), # noqa: E501 + 'tags': ([str],), # noqa: E501 + 'title': (str,), # noqa: E501 } @cached_property @@ -99,9 +101,11 @@ def discriminator(): attribute_map = { - 'type': 'type', # noqa: E501 - 'buckets': 'buckets', # noqa: E501 - 'columns': 'columns', # noqa: E501 + 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'content': 'content', # noqa: E501 + 'description': 'description', # noqa: E501 + 'tags': 'tags', # noqa: E501 + 'title': 'title', # noqa: E501 } read_only_vars = { @@ -112,12 +116,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """HashDistributionConfig - a model defined in OpenAPI - - Args: + """JsonApiReportTemplatePatchAttributes - a model defined in OpenAPI Keyword Args: - type (str): defaults to "hash", must be one of ["hash", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -148,11 +149,13 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - buckets (int): Number of hash buckets. Defaults to 1.. [optional] # noqa: E501 - columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 """ - type = kwargs.get('type', "hash") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -182,7 +185,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -204,12 +206,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """HashDistributionConfig - a model defined in OpenAPI - - Args: + """JsonApiReportTemplatePatchAttributes - a model defined in OpenAPI Keyword Args: - type (str): defaults to "hash", must be one of ["hash", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -240,11 +239,13 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - buckets (int): Number of hash buckets. Defaults to 1.. [optional] # noqa: E501 - columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 + are_relations_valid (bool): [optional] # noqa: E501 + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form deck definition, stored verbatim - not parsed, validated or migrated. Maximum supported length is 250000 characters.. [optional] # noqa: E501 + description (str): [optional] # noqa: E501 + tags ([str]): [optional] # noqa: E501 + title (str): [optional] # noqa: E501 """ - type = kwargs.get('type', "hash") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -272,7 +273,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_patch_document.py new file mode 100644 index 000000000..cf671dd0b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_patch import JsonApiReportTemplatePatch + globals()['JsonApiReportTemplatePatch'] = JsonApiReportTemplatePatch + + +class JsonApiReportTemplatePatchDocument(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': (JsonApiReportTemplatePatch,), # 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 + """JsonApiReportTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplatePatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportTemplatePatchDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplatePatch): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_report_template_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_post_optional_id.py new file mode 100644 index 000000000..e14a7e797 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_in_attributes import JsonApiReportTemplateInAttributes + globals()['JsonApiReportTemplateInAttributes'] = JsonApiReportTemplateInAttributes + + +class JsonApiReportTemplatePostOptionalId(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',): { + 'REPORTTEMPLATE': "reportTemplate", + }, + } + + 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': (JsonApiReportTemplateInAttributes,), # 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 + """JsonApiReportTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _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 + """JsonApiReportTemplatePostOptionalId - a model defined in OpenAPI + + Args: + attributes (JsonApiReportTemplateInAttributes): + + Keyword Args: + type (str): Object type. defaults to "reportTemplate", must be one of ["reportTemplate", ] # 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', "reportTemplate") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_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_report_template_post_optional_id_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_report_template_post_optional_id_document.py new file mode 100644 index 000000000..6442a6999 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_report_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_report_template_post_optional_id import JsonApiReportTemplatePostOptionalId + globals()['JsonApiReportTemplatePostOptionalId'] = JsonApiReportTemplatePostOptionalId + + +class JsonApiReportTemplatePostOptionalIdDocument(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': (JsonApiReportTemplatePostOptionalId,), # 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 + """JsonApiReportTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplatePostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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 + """JsonApiReportTemplatePostOptionalIdDocument - a model defined in OpenAPI + + Args: + data (JsonApiReportTemplatePostOptionalId): + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make 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_theme_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.py index 592f2bfc3..2196262f6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_theme_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_theme_out_with_links import JsonApiThemeOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiThemeOutWithLinks'] = JsonApiThemeOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiThemeOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py index 124c9b58b..e9f9489a4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_user_data_filter_out import JsonApiUserDataFilterOut from gooddata_api_client.model.json_api_user_data_filter_out_includes import JsonApiUserDataFilterOutIncludes from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiUserDataFilterOut'] = JsonApiUserDataFilterOut globals()['JsonApiUserDataFilterOutIncludes'] = JsonApiUserDataFilterOutIncludes globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiUserDataFilterOut,), # noqa: E501 'included': ([JsonApiUserDataFilterOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiUserDataFilterOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiUserDataFilterOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py index e1ab25c2b..363440796 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_includes.py @@ -33,6 +33,7 @@ def lazy_import(): from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta from gooddata_api_client.model.json_api_attribute_out_with_links import JsonApiAttributeOutWithLinks + from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_fact_out_with_links import JsonApiFactOutWithLinks from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks @@ -45,6 +46,7 @@ def lazy_import(): from gooddata_api_client.model.object_links import ObjectLinks globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta globals()['JsonApiAttributeOutWithLinks'] = JsonApiAttributeOutWithLinks + globals()['JsonApiComputedAttributeOutWithLinks'] = JsonApiComputedAttributeOutWithLinks globals()['JsonApiDatasetOutWithLinks'] = JsonApiDatasetOutWithLinks globals()['JsonApiFactOutWithLinks'] = JsonApiFactOutWithLinks globals()['JsonApiLabelOutWithLinks'] = JsonApiLabelOutWithLinks @@ -366,6 +368,7 @@ def _composed_schemas(): ], 'oneOf': [ JsonApiAttributeOutWithLinks, + JsonApiComputedAttributeOutWithLinks, JsonApiDatasetOutWithLinks, JsonApiFactOutWithLinks, JsonApiLabelOutWithLinks, diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py index 9c0c07f8e..284978501 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_data_filter_out_relationships.py @@ -31,20 +31,22 @@ def lazy_import(): + from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_computed_attributes import JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_labels import JsonApiAnalyticalDashboardOutRelationshipsLabels from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_metrics import JsonApiAnalyticalDashboardOutRelationshipsMetrics from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_parameters import JsonApiAnalyticalDashboardOutRelationshipsParameters from gooddata_api_client.model.json_api_attribute_hierarchy_out_relationships_attributes import JsonApiAttributeHierarchyOutRelationshipsAttributes - from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts + from gooddata_api_client.model.json_api_automation_out_relationships_facts import JsonApiAutomationOutRelationshipsFacts from gooddata_api_client.model.json_api_filter_view_in_relationships_user import JsonApiFilterViewInRelationshipsUser from gooddata_api_client.model.json_api_organization_out_relationships_bootstrap_user_group import JsonApiOrganizationOutRelationshipsBootstrapUserGroup + globals()['JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes'] = JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes globals()['JsonApiAnalyticalDashboardOutRelationshipsDatasets'] = JsonApiAnalyticalDashboardOutRelationshipsDatasets globals()['JsonApiAnalyticalDashboardOutRelationshipsLabels'] = JsonApiAnalyticalDashboardOutRelationshipsLabels globals()['JsonApiAnalyticalDashboardOutRelationshipsMetrics'] = JsonApiAnalyticalDashboardOutRelationshipsMetrics globals()['JsonApiAnalyticalDashboardOutRelationshipsParameters'] = JsonApiAnalyticalDashboardOutRelationshipsParameters globals()['JsonApiAttributeHierarchyOutRelationshipsAttributes'] = JsonApiAttributeHierarchyOutRelationshipsAttributes - globals()['JsonApiDatasetOutRelationshipsFacts'] = JsonApiDatasetOutRelationshipsFacts + globals()['JsonApiAutomationOutRelationshipsFacts'] = JsonApiAutomationOutRelationshipsFacts globals()['JsonApiFilterViewInRelationshipsUser'] = JsonApiFilterViewInRelationshipsUser globals()['JsonApiOrganizationOutRelationshipsBootstrapUserGroup'] = JsonApiOrganizationOutRelationshipsBootstrapUserGroup @@ -103,8 +105,9 @@ def openapi_types(): lazy_import() return { 'attributes': (JsonApiAttributeHierarchyOutRelationshipsAttributes,), # noqa: E501 + 'computed_attributes': (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes,), # noqa: E501 'datasets': (JsonApiAnalyticalDashboardOutRelationshipsDatasets,), # noqa: E501 - 'facts': (JsonApiDatasetOutRelationshipsFacts,), # noqa: E501 + 'facts': (JsonApiAutomationOutRelationshipsFacts,), # noqa: E501 'labels': (JsonApiAnalyticalDashboardOutRelationshipsLabels,), # noqa: E501 'metrics': (JsonApiAnalyticalDashboardOutRelationshipsMetrics,), # noqa: E501 'parameters': (JsonApiAnalyticalDashboardOutRelationshipsParameters,), # noqa: E501 @@ -119,6 +122,7 @@ def discriminator(): attribute_map = { 'attributes': 'attributes', # noqa: E501 + 'computed_attributes': 'computedAttributes', # noqa: E501 'datasets': 'datasets', # noqa: E501 'facts': 'facts', # noqa: E501 'labels': 'labels', # noqa: E501 @@ -170,8 +174,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 parameters (JsonApiAnalyticalDashboardOutRelationshipsParameters): [optional] # noqa: E501 @@ -263,8 +268,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) attributes (JsonApiAttributeHierarchyOutRelationshipsAttributes): [optional] # noqa: E501 + computed_attributes (JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes): [optional] # noqa: E501 datasets (JsonApiAnalyticalDashboardOutRelationshipsDatasets): [optional] # noqa: E501 - facts (JsonApiDatasetOutRelationshipsFacts): [optional] # noqa: E501 + facts (JsonApiAutomationOutRelationshipsFacts): [optional] # noqa: E501 labels (JsonApiAnalyticalDashboardOutRelationshipsLabels): [optional] # noqa: E501 metrics (JsonApiAnalyticalDashboardOutRelationshipsMetrics): [optional] # noqa: E501 parameters (JsonApiAnalyticalDashboardOutRelationshipsParameters): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py index 9569323ba..294e33dce 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_group_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_user_group_out import JsonApiUserGroupOut from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiUserGroupOut'] = JsonApiUserGroupOut globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiUserGroupOut,), # noqa: E501 'included': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py index 25d0e7719..6f34e9ab6 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_identifier_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta 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()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiUserIdentifierOutWithLinks'] = JsonApiUserIdentifierOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiUserIdentifierOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py index bf91724af..93a3579be 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_user_group_out_with_links import JsonApiUserGroupOutWithLinks from gooddata_api_client.model.json_api_user_out import JsonApiUserOut from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiUserGroupOutWithLinks'] = JsonApiUserGroupOutWithLinks globals()['JsonApiUserOut'] = JsonApiUserOut globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiUserOut,), # noqa: E501 'included': ([JsonApiUserGroupOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiUserGroupOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py index faa70c25a..5d0e3898c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes class JsonApiUserSettingIn(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "userSetting") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "userSetting") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.py new file mode 100644 index 000000000..b5b920abb --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_in_attributes.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 + + + +class JsonApiUserSettingInAttributes(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',): { + 'TIMEZONE': "TIMEZONE", + 'ACTIVE_THEME': "ACTIVE_THEME", + 'ACTIVE_COLOR_PALETTE': "ACTIVE_COLOR_PALETTE", + 'ACTIVE_LLM_PROVIDER': "ACTIVE_LLM_PROVIDER", + 'ACTIVE_CALENDARS': "ACTIVE_CALENDARS", + 'WHITE_LABELING': "WHITE_LABELING", + 'LOCALE': "LOCALE", + 'METADATA_LOCALE': "METADATA_LOCALE", + 'FORMAT_LOCALE': "FORMAT_LOCALE", + 'MAPBOX_TOKEN': "MAPBOX_TOKEN", + 'GEO_ICON_SHEET': "GEO_ICON_SHEET", + 'AG_GRID_TOKEN': "AG_GRID_TOKEN", + 'WEEK_START': "WEEK_START", + 'FISCAL_YEAR': "FISCAL_YEAR", + 'SHOW_HIDDEN_CATALOG_ITEMS': "SHOW_HIDDEN_CATALOG_ITEMS", + 'OPERATOR_OVERRIDES': "OPERATOR_OVERRIDES", + 'TIMEZONE_VALIDATION_ENABLED': "TIMEZONE_VALIDATION_ENABLED", + 'OPENAI_CONFIG': "OPENAI_CONFIG", + 'ENABLE_FILE_ANALYTICS': "ENABLE_FILE_ANALYTICS", + 'ALERT': "ALERT", + 'SEPARATORS': "SEPARATORS", + 'DATE_FILTER_CONFIG': "DATE_FILTER_CONFIG", + 'JIT_PROVISIONING': "JIT_PROVISIONING", + 'JWT_JIT_PROVISIONING': "JWT_JIT_PROVISIONING", + 'DASHBOARD_FILTERS_APPLY_MODE': "DASHBOARD_FILTERS_APPLY_MODE", + 'ENABLE_SLIDES_EXPORT': "ENABLE_SLIDES_EXPORT", + 'DEFAULT_EXPORT_TEMPLATE': "DEFAULT_EXPORT_TEMPLATE", + 'ENABLE_SNAPSHOT_EXPORT': "ENABLE_SNAPSHOT_EXPORT", + 'AI_RATE_LIMIT': "AI_RATE_LIMIT", + 'ATTACHMENT_SIZE_LIMIT': "ATTACHMENT_SIZE_LIMIT", + 'ATTACHMENT_LINK_TTL': "ATTACHMENT_LINK_TTL", + 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE': "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", + 'ENABLE_DRILL_TO_URL_BY_DEFAULT': "ENABLE_DRILL_TO_URL_BY_DEFAULT", + 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS': "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", + 'ENABLE_AUTOMATION_EVALUATION_MODE': "ENABLE_AUTOMATION_EVALUATION_MODE", + 'ENABLE_ACCESSIBILITY_MODE': "ENABLE_ACCESSIBILITY_MODE", + 'REGISTERED_PLUGGABLE_APPLICATIONS': "REGISTERED_PLUGGABLE_APPLICATIONS", + 'DATA_LOCALE': "DATA_LOCALE", + 'LDM_DEFAULT_LOCALE': "LDM_DEFAULT_LOCALE", + 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", + 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", + 'CONVERSATION_RETENTION_DAYS': "CONVERSATION_RETENTION_DAYS", + 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", + 'SORT_COLLATION': "SORT_COLLATION", + 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", + 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", + 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", + 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", + 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", + 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", + 'EXPORT_CSV_CUSTOM_DELIMITER': "EXPORT_CSV_CUSTOM_DELIMITER", + 'ENABLE_QUERY_TAGS': "ENABLE_QUERY_TAGS", + 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", + 'CERTIFY_PARENT_OBJECTS': "CERTIFY_PARENT_OBJECTS", + 'HLL_TYPE': "HLL_TYPE", + 'ENABLE_TIMEZONE_CHANGE': "ENABLE_TIMEZONE_CHANGE", + 'DEFAULT_VISUALIZATION_VISIBILITY': "DEFAULT_VISUALIZATION_VISIBILITY", + 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", + 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", + }, + } + + 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 { + 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 + 'type': (str,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'content': 'content', # 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 + """JsonApiUserSettingInAttributes - 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,) + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 + 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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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 + """JsonApiUserSettingInAttributes - 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,) + content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 15000 characters.. [optional] # noqa: E501 + 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__,) + + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is 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_user_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out.py index 4d0cda2b6..2ba1327c3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes class JsonApiUserSettingOut(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "userSetting") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "userSetting") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py index fdf6e65e0..15173e271 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_user_setting_out_with_links import JsonApiUserSettingOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiUserSettingOutWithLinks'] = JsonApiUserSettingOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiUserSettingOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py index 8793fa0bc..b058f4b50 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_user_setting_out_with_links.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes globals()['JsonApiUserSettingOut'] = JsonApiUserSettingOut globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -104,7 +104,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -161,7 +161,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -269,7 +269,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py index 52fad07ff..ff72a9130 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_visualization_object_in_attributes_conditional_formatting import JsonApiVisualizationObjectInAttributesConditionalFormatting + globals()['JsonApiVisualizationObjectInAttributesConditionalFormatting'] = JsonApiVisualizationObjectInAttributesConditionalFormatting + class JsonApiVisualizationObjectInAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -73,6 +77,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -87,9 +92,11 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 + 'conditional_formatting': (JsonApiVisualizationObjectInAttributesConditionalFormatting,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 'tags': ([str],), # noqa: E501 @@ -104,6 +111,7 @@ def discriminator(): attribute_map = { 'content': 'content', # noqa: E501 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 'tags': 'tags', # noqa: E501 @@ -155,6 +163,7 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiVisualizationObjectInAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 @@ -249,6 +258,7 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiVisualizationObjectInAttributesConditionalFormatting): [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 tags ([str]): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/reasoning.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes_conditional_formatting.py similarity index 89% rename from gooddata-api-client/gooddata_api_client/model/reasoning.py rename to gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes_conditional_formatting.py index 5f3d3c73e..e24db64f4 100644 --- a/gooddata-api-client/gooddata_api_client/model/reasoning.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_in_attributes_conditional_formatting.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.reasoning_step import ReasoningStep - globals()['ReasoningStep'] = ReasoningStep + from gooddata_api_client.model.conditional_formatting_rule import ConditionalFormattingRule + globals()['ConditionalFormattingRule'] = ConditionalFormattingRule -class Reasoning(ModelNormal): +class JsonApiVisualizationObjectInAttributesConditionalFormatting(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -74,7 +74,7 @@ def additional_properties_type(): lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - _nullable = False + _nullable = True @cached_property def openapi_types(): @@ -88,8 +88,8 @@ def openapi_types(): """ lazy_import() return { - 'steps': ([ReasoningStep],), # noqa: E501 - 'answer': (str,), # noqa: E501 + 'enabled': (bool,), # noqa: E501 + 'rules': ([ConditionalFormattingRule],), # noqa: E501 } @cached_property @@ -98,8 +98,8 @@ def discriminator(): attribute_map = { - 'steps': 'steps', # noqa: E501 - 'answer': 'answer', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 + 'rules': 'rules', # noqa: E501 } read_only_vars = { @@ -109,11 +109,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, steps, *args, **kwargs): # noqa: E501 - """Reasoning - a model defined in OpenAPI + def _from_openapi_data(cls, enabled, rules, *args, **kwargs): # noqa: E501 + """JsonApiVisualizationObjectInAttributesConditionalFormatting - a model defined in OpenAPI Args: - steps ([ReasoningStep]): Steps taken during processing, showing the AI's reasoning process. + enabled (bool): Whether the rules are applied when rendering. + rules ([ConditionalFormattingRule]): Rules evaluated in order; within a target, the first matching condition wins. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -146,7 +147,6 @@ def _from_openapi_data(cls, steps, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - answer (str): Final answer/reasoning from the use case result.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -178,7 +178,8 @@ def _from_openapi_data(cls, steps, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.steps = steps + self.enabled = enabled + self.rules = rules for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -199,11 +200,12 @@ def _from_openapi_data(cls, steps, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, steps, *args, **kwargs): # noqa: E501 - """Reasoning - a model defined in OpenAPI + def __init__(self, enabled, rules, *args, **kwargs): # noqa: E501 + """JsonApiVisualizationObjectInAttributesConditionalFormatting - a model defined in OpenAPI Args: - steps ([ReasoningStep]): Steps taken during processing, showing the AI's reasoning process. + enabled (bool): Whether the rules are applied when rendering. + rules ([ConditionalFormattingRule]): Rules evaluated in order; within a target, the first matching condition wins. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -236,7 +238,6 @@ def __init__(self, steps, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - answer (str): Final answer/reasoning from the use case result.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -266,7 +267,8 @@ def __init__(self, steps, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.steps = steps + self.enabled = enabled + self.rules = rules for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py index 5cbb922c9..3f6633b2a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships globals()['JsonApiVisualizationObjectOutAttributes'] = JsonApiVisualizationObjectOutAttributes @@ -103,8 +103,8 @@ def openapi_types(): 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 } @cached_property @@ -166,8 +166,8 @@ def _from_openapi_data(cls, attributes, 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,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 """ type = kwargs.get('type', "visualizationObject") @@ -262,8 +262,8 @@ def __init__(self, attributes, 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,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 """ type = kwargs.get('type', "visualizationObject") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py index 56cc4b6a4..56268808a 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_attributes.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_visualization_object_in_attributes_conditional_formatting import JsonApiVisualizationObjectInAttributesConditionalFormatting + globals()['JsonApiVisualizationObjectInAttributesConditionalFormatting'] = JsonApiVisualizationObjectInAttributesConditionalFormatting + class JsonApiVisualizationObjectOutAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -91,6 +95,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -105,12 +110,14 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 'are_relations_valid': (bool,), # noqa: E501 'certification': (str,), # noqa: E501 'certification_message': (str, none_type,), # noqa: E501 'certified_at': (datetime, none_type,), # noqa: E501 + 'conditional_formatting': (JsonApiVisualizationObjectInAttributesConditionalFormatting,), # noqa: E501 'created_at': (datetime, none_type,), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -130,6 +137,7 @@ def discriminator(): 'certification': 'certification', # noqa: E501 'certification_message': 'certificationMessage', # noqa: E501 'certified_at': 'certifiedAt', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'created_at': 'createdAt', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -186,6 +194,7 @@ def _from_openapi_data(cls, content, *args, **kwargs): # noqa: E501 certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (datetime, none_type): Time when the certification was set.. [optional] # noqa: E501 + conditional_formatting (JsonApiVisualizationObjectInAttributesConditionalFormatting): [optional] # noqa: E501 created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -285,6 +294,7 @@ def __init__(self, content, *args, **kwargs): # noqa: E501 certification (str): Certification status of the entity.. [optional] if omitted the server will use the default value of "CERTIFIED" # noqa: E501 certification_message (str, none_type): Optional message associated with the certification.. [optional] # noqa: E501 certified_at (datetime, none_type): Time when the certification was set.. [optional] # noqa: E501 + conditional_formatting (JsonApiVisualizationObjectInAttributesConditionalFormatting): [optional] # noqa: E501 created_at (datetime, none_type): Time of the entity creation.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py index 60ba9cea1..dbe5ba3ef 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_document.py @@ -31,10 +31,12 @@ def lazy_import(): - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta + from gooddata_api_client.model.json_api_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut from gooddata_api_client.model.object_links import ObjectLinks - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta + globals()['JsonApiComputedAttributeOutIncludes'] = JsonApiComputedAttributeOutIncludes globals()['JsonApiVisualizationObjectOut'] = JsonApiVisualizationObjectOut globals()['ObjectLinks'] = ObjectLinks @@ -95,8 +97,9 @@ def openapi_types(): lazy_import() return { 'data': (JsonApiVisualizationObjectOut,), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiComputedAttributeOutIncludes],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -154,8 +158,9 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -245,8 +250,9 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py index a1f161bef..955b3a210 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_list.py @@ -32,11 +32,11 @@ def lazy_import(): from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta - from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes + from gooddata_api_client.model.json_api_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes from gooddata_api_client.model.json_api_visualization_object_out_with_links import JsonApiVisualizationObjectOutWithLinks from gooddata_api_client.model.list_links import ListLinks globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta - globals()['JsonApiMetricOutIncludes'] = JsonApiMetricOutIncludes + globals()['JsonApiComputedAttributeOutIncludes'] = JsonApiComputedAttributeOutIncludes globals()['JsonApiVisualizationObjectOutWithLinks'] = JsonApiVisualizationObjectOutWithLinks globals()['ListLinks'] = ListLinks @@ -99,7 +99,7 @@ def openapi_types(): lazy_import() return { 'data': ([JsonApiVisualizationObjectOutWithLinks],), # noqa: E501 - 'included': ([JsonApiMetricOutIncludes],), # noqa: E501 + 'included': ([JsonApiComputedAttributeOutIncludes],), # noqa: E501 'links': (ListLinks,), # noqa: E501 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 } @@ -160,7 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 """ @@ -252,7 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - included ([JsonApiMetricOutIncludes]): Included resources. [optional] # noqa: E501 + included ([JsonApiComputedAttributeOutIncludes]): Included resources. [optional] # noqa: E501 links (ListLinks): [optional] # noqa: E501 meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py index a5a3ccc57..aceba2624 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_out_with_links.py @@ -31,14 +31,14 @@ def lazy_import(): - from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships + from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta + from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut from gooddata_api_client.model.json_api_visualization_object_out_attributes import JsonApiVisualizationObjectOutAttributes from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer - globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiMetricOutRelationships'] = JsonApiMetricOutRelationships + globals()['JsonApiAttributeOutMeta'] = JsonApiAttributeOutMeta + globals()['JsonApiComputedAttributeOutRelationships'] = JsonApiComputedAttributeOutRelationships globals()['JsonApiVisualizationObjectOut'] = JsonApiVisualizationObjectOut globals()['JsonApiVisualizationObjectOutAttributes'] = JsonApiVisualizationObjectOutAttributes globals()['ObjectLinks'] = ObjectLinks @@ -109,8 +109,8 @@ def openapi_types(): 'attributes': (JsonApiVisualizationObjectOutAttributes,), # noqa: E501 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 - 'relationships': (JsonApiMetricOutRelationships,), # noqa: E501 + 'meta': (JsonApiAttributeOutMeta,), # noqa: E501 + 'relationships': (JsonApiComputedAttributeOutRelationships,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -170,8 +170,8 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -280,8 +280,8 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 - relationships (JsonApiMetricOutRelationships): [optional] # noqa: E501 + meta (JsonApiAttributeOutMeta): [optional] # noqa: E501 + relationships (JsonApiComputedAttributeOutRelationships): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py index 0656b4c65..2456b43b7 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_visualization_object_patch_attributes.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.json_api_visualization_object_in_attributes_conditional_formatting import JsonApiVisualizationObjectInAttributesConditionalFormatting + globals()['JsonApiVisualizationObjectInAttributesConditionalFormatting'] = JsonApiVisualizationObjectInAttributesConditionalFormatting + class JsonApiVisualizationObjectPatchAttributes(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -73,6 +77,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -87,8 +92,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'are_relations_valid': (bool,), # noqa: E501 + 'conditional_formatting': (JsonApiVisualizationObjectInAttributesConditionalFormatting,), # noqa: E501 'content': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},), # noqa: E501 'description': (str,), # noqa: E501 'is_hidden': (bool,), # noqa: E501 @@ -103,6 +110,7 @@ def discriminator(): attribute_map = { 'are_relations_valid': 'areRelationsValid', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'content': 'content', # noqa: E501 'description': 'description', # noqa: E501 'is_hidden': 'isHidden', # noqa: E501 @@ -152,6 +160,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiVisualizationObjectInAttributesConditionalFormatting): [optional] # noqa: E501 content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 @@ -243,6 +252,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) are_relations_valid (bool): [optional] # noqa: E501 + conditional_formatting (JsonApiVisualizationObjectInAttributesConditionalFormatting): [optional] # noqa: E501 content ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Free-form JSON content. Maximum supported length is 250000 characters.. [optional] # noqa: E501 description (str): [optional] # noqa: E501 is_hidden (bool): [optional] # noqa: E501 diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_list.py index 472c52e3d..1fa05d9be 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_color_palette_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_workspace_color_palette_out_with_links import JsonApiWorkspaceColorPaletteOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiWorkspaceColorPaletteOutWithLinks'] = JsonApiWorkspaceColorPaletteOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiWorkspaceColorPaletteOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py index 370909507..73dfe4959 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_workspace_data_filter_out import JsonApiWorkspaceDataFilterOut from gooddata_api_client.model.json_api_workspace_data_filter_setting_out_with_links import JsonApiWorkspaceDataFilterSettingOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiWorkspaceDataFilterOut'] = JsonApiWorkspaceDataFilterOut globals()['JsonApiWorkspaceDataFilterSettingOutWithLinks'] = JsonApiWorkspaceDataFilterSettingOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiWorkspaceDataFilterOut,), # noqa: E501 'included': ([JsonApiWorkspaceDataFilterSettingOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiWorkspaceDataFilterSettingOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py index 8cf426cb8..261303a74 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_data_filter_setting_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_workspace_data_filter_out_with_links import JsonApiWorkspaceDataFilterOutWithLinks from gooddata_api_client.model.json_api_workspace_data_filter_setting_out import JsonApiWorkspaceDataFilterSettingOut from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiWorkspaceDataFilterOutWithLinks'] = JsonApiWorkspaceDataFilterOutWithLinks globals()['JsonApiWorkspaceDataFilterSettingOut'] = JsonApiWorkspaceDataFilterSettingOut globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiWorkspaceDataFilterSettingOut,), # noqa: E501 'included': ([JsonApiWorkspaceDataFilterOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiWorkspaceDataFilterOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiWorkspaceDataFilterOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_list.py index a30c65400..a1d551d98 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_export_template_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_workspace_export_template_out_with_links import JsonApiWorkspaceExportTemplateOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiWorkspaceExportTemplateOutWithLinks'] = JsonApiWorkspaceExportTemplateOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiWorkspaceExportTemplateOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py index bf19ab726..364afa834 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_document.py @@ -31,9 +31,11 @@ def lazy_import(): + from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_workspace_out import JsonApiWorkspaceOut from gooddata_api_client.model.json_api_workspace_out_with_links import JsonApiWorkspaceOutWithLinks from gooddata_api_client.model.object_links import ObjectLinks + globals()['JsonApiAgentOutDocumentMeta'] = JsonApiAgentOutDocumentMeta globals()['JsonApiWorkspaceOut'] = JsonApiWorkspaceOut globals()['JsonApiWorkspaceOutWithLinks'] = JsonApiWorkspaceOutWithLinks globals()['ObjectLinks'] = ObjectLinks @@ -97,6 +99,7 @@ def openapi_types(): 'data': (JsonApiWorkspaceOut,), # noqa: E501 'included': ([JsonApiWorkspaceOutWithLinks],), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 + 'meta': (JsonApiAgentOutDocumentMeta,), # noqa: E501 } @cached_property @@ -108,6 +111,7 @@ def discriminator(): 'data': 'data', # noqa: E501 'included': 'included', # noqa: E501 'links': 'links', # noqa: E501 + 'meta': 'meta', # noqa: E501 } read_only_vars = { @@ -156,6 +160,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiWorkspaceOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -247,6 +252,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) included ([JsonApiWorkspaceOutWithLinks]): Included resources. [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 + meta (JsonApiAgentOutDocumentMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py index 1e95c7ccb..71a01738c 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_out_meta.py @@ -76,6 +76,7 @@ class JsonApiWorkspaceOutMeta(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py index f86f1ac13..c021557e9 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_in.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes class JsonApiWorkspaceSettingIn(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "workspaceSetting") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "workspaceSetting") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py index 91a07a48b..8e3f6b8a3 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out.py @@ -32,9 +32,9 @@ def lazy_import(): from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes class JsonApiWorkspaceSettingOut(ModelNormal): @@ -100,7 +100,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 } @@ -161,7 +161,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 """ @@ -255,7 +255,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py index c386f1a2f..b366f14d4 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_workspace_setting_out_with_links import JsonApiWorkspaceSettingOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiWorkspaceSettingOutWithLinks'] = JsonApiWorkspaceSettingOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiWorkspaceSettingOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py index e0fcec1e5..787aede0b 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_out_with_links.py @@ -32,12 +32,12 @@ def lazy_import(): from gooddata_api_client.model.json_api_aggregated_fact_out_meta import JsonApiAggregatedFactOutMeta - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer globals()['JsonApiAggregatedFactOutMeta'] = JsonApiAggregatedFactOutMeta - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes globals()['JsonApiWorkspaceSettingOut'] = JsonApiWorkspaceSettingOut globals()['ObjectLinks'] = ObjectLinks globals()['ObjectLinksContainer'] = ObjectLinksContainer @@ -106,7 +106,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 'meta': (JsonApiAggregatedFactOutMeta,), # noqa: E501 'links': (ObjectLinks,), # noqa: E501 } @@ -165,7 +165,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ @@ -274,7 +274,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 meta (JsonApiAggregatedFactOutMeta): [optional] # noqa: E501 links (ObjectLinks): [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py index 8c7fb324b..2445cfef5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_patch.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes class JsonApiWorkspaceSettingPatch(ModelNormal): @@ -98,7 +98,7 @@ def openapi_types(): return { 'id': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 } @cached_property @@ -157,7 +157,7 @@ def _from_openapi_data(cls, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "workspaceSetting") @@ -250,7 +250,7 @@ def __init__(self, id, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 """ type = kwargs.get('type', "workspaceSetting") diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py index 1e88a7caf..83cd868a5 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_setting_post_optional_id.py @@ -31,8 +31,8 @@ def lazy_import(): - from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes - globals()['JsonApiOrganizationSettingInAttributes'] = JsonApiOrganizationSettingInAttributes + from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes + globals()['JsonApiUserSettingInAttributes'] = JsonApiUserSettingInAttributes class JsonApiWorkspaceSettingPostOptionalId(ModelNormal): @@ -97,7 +97,7 @@ def openapi_types(): lazy_import() return { 'type': (str,), # noqa: E501 - 'attributes': (JsonApiOrganizationSettingInAttributes,), # noqa: E501 + 'attributes': (JsonApiUserSettingInAttributes,), # noqa: E501 'id': (str,), # noqa: E501 } @@ -156,7 +156,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 """ @@ -248,7 +248,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - attributes (JsonApiOrganizationSettingInAttributes): [optional] # noqa: E501 + attributes (JsonApiUserSettingInAttributes): [optional] # noqa: E501 id (str): API identifier of an object. [optional] # noqa: E501 """ diff --git a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_list.py b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_list.py index 3ae752f37..6b9cbb72d 100644 --- a/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_list.py +++ b/gooddata-api-client/gooddata_api_client/model/json_api_workspace_theme_out_list.py @@ -31,10 +31,10 @@ def lazy_import(): - from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta + from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_workspace_theme_out_with_links import JsonApiWorkspaceThemeOutWithLinks from gooddata_api_client.model.list_links import ListLinks - globals()['JsonApiAgentOutListMeta'] = JsonApiAgentOutListMeta + globals()['JsonApiApiTokenOutListMeta'] = JsonApiApiTokenOutListMeta globals()['JsonApiWorkspaceThemeOutWithLinks'] = JsonApiWorkspaceThemeOutWithLinks globals()['ListLinks'] = ListLinks @@ -96,7 +96,7 @@ def openapi_types(): return { 'data': ([JsonApiWorkspaceThemeOutWithLinks],), # noqa: E501 'links': (ListLinks,), # noqa: E501 - 'meta': (JsonApiAgentOutListMeta,), # noqa: E501 + 'meta': (JsonApiApiTokenOutListMeta,), # noqa: E501 } @cached_property @@ -155,7 +155,7 @@ def _from_openapi_data(cls, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -246,7 +246,7 @@ def __init__(self, data, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) links (ListLinks): [optional] # noqa: E501 - meta (JsonApiAgentOutListMeta): [optional] # noqa: E501 + meta (JsonApiApiTokenOutListMeta): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/key_config.py b/gooddata-api-client/gooddata_api_client/model/key_config.py deleted file mode 100644 index 5e63be3e2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/key_config.py +++ /dev/null @@ -1,273 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class KeyConfig(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 { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - val = { - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """KeyConfig - a model defined in OpenAPI - - Args: - 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,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """KeyConfig - a model defined in OpenAPI - - Args: - 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,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/manage_computed_attribute_permissions_request_inner.py b/gooddata-api-client/gooddata_api_client/model/manage_computed_attribute_permissions_request_inner.py new file mode 100644 index 000000000..5fbadcdbd --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/manage_computed_attribute_permissions_request_inner.py @@ -0,0 +1,340 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier + from gooddata_api_client.model.assignee_rule import AssigneeRule + from gooddata_api_client.model.computed_attribute_permissions_for_assignee import ComputedAttributePermissionsForAssignee + from gooddata_api_client.model.computed_attribute_permissions_for_assignee_rule import ComputedAttributePermissionsForAssigneeRule + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AssigneeRule'] = AssigneeRule + globals()['ComputedAttributePermissionsForAssignee'] = ComputedAttributePermissionsForAssignee + globals()['ComputedAttributePermissionsForAssigneeRule'] = ComputedAttributePermissionsForAssigneeRule + + +class ManageComputedAttributePermissionsRequestInner(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'permissions': ([str],), # noqa: E501 + 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 + 'assignee_rule': 'assigneeRule', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """ManageComputedAttributePermissionsRequestInner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + permissions ([str]): [optional] # noqa: E501 + assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 + assignee_rule (AssigneeRule): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """ManageComputedAttributePermissionsRequestInner - a model defined in OpenAPI + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + permissions ([str]): [optional] # noqa: E501 + assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 + assignee_rule (AssigneeRule): [optional] # noqa: E501 + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + ], + 'oneOf': [ + ComputedAttributePermissionsForAssignee, + ComputedAttributePermissionsForAssigneeRule, + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_distribution_config.py b/gooddata-api-client/gooddata_api_client/model/manage_visualization_permissions_request_inner.py similarity index 87% rename from gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_distribution_config.py rename to gooddata-api-client/gooddata_api_client/model/manage_visualization_permissions_request_inner.py index bf6028314..234d5dd48 100644 --- a/gooddata-api-client/gooddata_api_client/model/create_pipe_table_request_distribution_config.py +++ b/gooddata-api-client/gooddata_api_client/model/manage_visualization_permissions_request_inner.py @@ -31,13 +31,17 @@ def lazy_import(): - from gooddata_api_client.model.hash_distribution_config import HashDistributionConfig - from gooddata_api_client.model.random_distribution_config import RandomDistributionConfig - globals()['HashDistributionConfig'] = HashDistributionConfig - globals()['RandomDistributionConfig'] = RandomDistributionConfig + from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier + from gooddata_api_client.model.assignee_rule import AssigneeRule + from gooddata_api_client.model.visualization_permissions_for_assignee import VisualizationPermissionsForAssignee + from gooddata_api_client.model.visualization_permissions_for_assignee_rule import VisualizationPermissionsForAssigneeRule + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AssigneeRule'] = AssigneeRule + globals()['VisualizationPermissionsForAssignee'] = VisualizationPermissionsForAssignee + globals()['VisualizationPermissionsForAssigneeRule'] = VisualizationPermissionsForAssigneeRule -class CreatePipeTableRequestDistributionConfig(ModelComposed): +class ManageVisualizationPermissionsRequestInner(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -62,15 +66,14 @@ class CreatePipeTableRequestDistributionConfig(ModelComposed): """ allowed_values = { - ('type',): { - 'RANDOM': "random", + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", }, } validations = { - ('buckets',): { - 'inclusive_minimum': 1, - }, } @cached_property @@ -96,9 +99,9 @@ def openapi_types(): """ lazy_import() return { - 'buckets': (int,), # noqa: E501 - 'columns': ([str],), # noqa: E501 - 'type': (str,), # noqa: E501 + 'permissions': ([str],), # noqa: E501 + 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 } @cached_property @@ -107,9 +110,9 @@ def discriminator(): attribute_map = { - 'buckets': 'buckets', # noqa: E501 - 'columns': 'columns', # noqa: E501 - 'type': 'type', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 + 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 + 'assignee_rule': 'assigneeRule', # noqa: E501 } read_only_vars = { @@ -118,7 +121,7 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequestDistributionConfig - a model defined in OpenAPI + """ManageVisualizationPermissionsRequestInner - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -151,9 +154,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 - columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "random" # noqa: E501 + permissions ([str]): [optional] # noqa: E501 + assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 + assignee_rule (AssigneeRule): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -224,7 +227,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """CreatePipeTableRequestDistributionConfig - a model defined in OpenAPI + """ManageVisualizationPermissionsRequestInner - a model defined in OpenAPI Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -257,9 +260,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - buckets (int): Number of random distribution buckets. Defaults to 1.. [optional] # noqa: E501 - columns ([str]): Columns to distribute by. Defaults to first column.. [optional] # noqa: E501 - type (str): [optional] if omitted the server will use the default value of "random" # noqa: E501 + permissions ([str]): [optional] # noqa: E501 + assignee_identifier (AssigneeIdentifier): [optional] # noqa: E501 + assignee_rule (AssigneeRule): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -331,7 +334,7 @@ def _composed_schemas(): 'allOf': [ ], 'oneOf': [ - HashDistributionConfig, - RandomDistributionConfig, + VisualizationPermissionsForAssignee, + VisualizationPermissionsForAssigneeRule, ], } diff --git a/gooddata-api-client/gooddata_api_client/model/metric_value_change.py b/gooddata-api-client/gooddata_api_client/model/metric_value_change.py index d92704130..79b51c5f5 100644 --- a/gooddata-api-client/gooddata_api_client/model/metric_value_change.py +++ b/gooddata-api-client/gooddata_api_client/model/metric_value_change.py @@ -30,6 +30,10 @@ from gooddata_api_client.exceptions import ApiAttributeError +def lazy_import(): + from gooddata_api_client.model.afm_object_identifier_label import AfmObjectIdentifierLabel + globals()['AfmObjectIdentifierLabel'] = AfmObjectIdentifierLabel + class MetricValueChange(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. @@ -67,6 +71,7 @@ def additional_properties_type(): This must be a method because a model may have properties that are of type self, this must run after the class is loaded """ + lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 _nullable = False @@ -81,8 +86,10 @@ def openapi_types(): openapi_types (dict): The key is attribute name and the value is attribute type. """ + lazy_import() return { 'attribute_name': (str,), # noqa: E501 + 'attribute_ref': (AfmObjectIdentifierLabel,), # noqa: E501 'attribute_value': (str,), # noqa: E501 'attribute_values_change_mean': (float,), # noqa: E501 'attribute_values_change_std': (float,), # noqa: E501 @@ -102,6 +109,7 @@ def discriminator(): attribute_map = { 'attribute_name': 'attributeName', # noqa: E501 + 'attribute_ref': 'attributeRef', # noqa: E501 'attribute_value': 'attributeValue', # noqa: E501 'attribute_values_change_mean': 'attributeValuesChangeMean', # noqa: E501 'attribute_values_change_std': 'attributeValuesChangeStd', # noqa: E501 @@ -121,11 +129,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, attribute_name, attribute_value, attribute_values_change_mean, attribute_values_change_std, is_significant_change, metric_value_delta, metric_value_delta_abs, metric_value_in_analyzed_period, metric_value_in_reference_period, overall_metric_value_in_analyzed_period, overall_metric_value_in_reference_period, *args, **kwargs): # noqa: E501 + def _from_openapi_data(cls, attribute_name, attribute_ref, attribute_value, attribute_values_change_mean, attribute_values_change_std, is_significant_change, metric_value_delta, metric_value_delta_abs, metric_value_in_analyzed_period, metric_value_in_reference_period, overall_metric_value_in_analyzed_period, overall_metric_value_in_reference_period, *args, **kwargs): # noqa: E501 """MetricValueChange - a model defined in OpenAPI Args: - attribute_name (str): The name of the attribute being analyzed + attribute_name (str): Deprecated: bare id of the analyzed label or computed attribute, without its type. Use attributeRef instead. + attribute_ref (AfmObjectIdentifierLabel): attribute_value (str): The value of the attribute being analyzed attribute_values_change_mean (float): The mean of attribute value changes for the attribute being analyzed attribute_values_change_std (float): The standard deviation of attribute value changes for the attribute being analyzed @@ -200,6 +209,7 @@ def _from_openapi_data(cls, attribute_name, attribute_value, attribute_values_ch self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.attribute_name = attribute_name + self.attribute_ref = attribute_ref self.attribute_value = attribute_value self.attribute_values_change_mean = attribute_values_change_mean self.attribute_values_change_std = attribute_values_change_std @@ -230,11 +240,12 @@ def _from_openapi_data(cls, attribute_name, attribute_value, attribute_values_ch ]) @convert_js_args_to_python_args - def __init__(self, attribute_name, attribute_value, attribute_values_change_mean, attribute_values_change_std, is_significant_change, metric_value_delta, metric_value_delta_abs, metric_value_in_analyzed_period, metric_value_in_reference_period, overall_metric_value_in_analyzed_period, overall_metric_value_in_reference_period, *args, **kwargs): # noqa: E501 + def __init__(self, attribute_name, attribute_ref, attribute_value, attribute_values_change_mean, attribute_values_change_std, is_significant_change, metric_value_delta, metric_value_delta_abs, metric_value_in_analyzed_period, metric_value_in_reference_period, overall_metric_value_in_analyzed_period, overall_metric_value_in_reference_period, *args, **kwargs): # noqa: E501 """MetricValueChange - a model defined in OpenAPI Args: - attribute_name (str): The name of the attribute being analyzed + attribute_name (str): Deprecated: bare id of the analyzed label or computed attribute, without its type. Use attributeRef instead. + attribute_ref (AfmObjectIdentifierLabel): attribute_value (str): The value of the attribute being analyzed attribute_values_change_mean (float): The mean of attribute value changes for the attribute being analyzed attribute_values_change_std (float): The standard deviation of attribute value changes for the attribute being analyzed @@ -307,6 +318,7 @@ def __init__(self, attribute_name, attribute_value, attribute_values_change_mean self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.attribute_name = attribute_name + self.attribute_ref = attribute_ref self.attribute_value = attribute_value self.attribute_values_change_mean = attribute_values_change_mean self.attribute_values_change_std = attribute_values_change_std diff --git a/gooddata-api-client/gooddata_api_client/model/notification_parameter.py b/gooddata-api-client/gooddata_api_client/model/notification_parameter.py index 64a9cafab..e9075882d 100644 --- a/gooddata-api-client/gooddata_api_client/model/notification_parameter.py +++ b/gooddata-api-client/gooddata_api_client/model/notification_parameter.py @@ -85,6 +85,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'value': (str,), # noqa: E501 'title': (str,), # noqa: E501 + 'value_title': (str,), # noqa: E501 } @cached_property @@ -96,6 +97,7 @@ def discriminator(): 'id': 'id', # noqa: E501 'value': 'value', # noqa: E501 'title': 'title', # noqa: E501 + 'value_title': 'valueTitle', # noqa: E501 } read_only_vars = { @@ -144,6 +146,7 @@ def _from_openapi_data(cls, id, value, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) title (str): [optional] # noqa: E501 + value_title (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -236,6 +239,7 @@ def __init__(self, id, value, *args, **kwargs): # noqa: E501 through its discriminator because we passed in _visited_composed_classes = (Animal,) title (str): [optional] # noqa: E501 + value_title (str): [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/dashboard_context.py b/gooddata-api-client/gooddata_api_client/model/object_conditional_formatting.py similarity index 89% rename from gooddata-api-client/gooddata_api_client/model/dashboard_context.py rename to gooddata-api-client/gooddata_api_client/model/object_conditional_formatting.py index aa4c6a97b..a43bcfbc1 100644 --- a/gooddata-api-client/gooddata_api_client/model/dashboard_context.py +++ b/gooddata-api-client/gooddata_api_client/model/object_conditional_formatting.py @@ -31,11 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.widget_descriptor import WidgetDescriptor - globals()['WidgetDescriptor'] = WidgetDescriptor + from gooddata_api_client.model.conditional_formatting_condition import ConditionalFormattingCondition + globals()['ConditionalFormattingCondition'] = ConditionalFormattingCondition -class DashboardContext(ModelNormal): +class ObjectConditionalFormatting(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -74,7 +74,7 @@ def additional_properties_type(): lazy_import() return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - _nullable = False + _nullable = True @cached_property def openapi_types(): @@ -88,8 +88,8 @@ def openapi_types(): """ lazy_import() return { - 'id': (str,), # noqa: E501 - 'widgets': ([WidgetDescriptor],), # noqa: E501 + 'conditions': ([ConditionalFormattingCondition],), # noqa: E501 + 'enabled': (bool,), # noqa: E501 } @cached_property @@ -98,8 +98,8 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'widgets': 'widgets', # noqa: E501 + 'conditions': 'conditions', # noqa: E501 + 'enabled': 'enabled', # noqa: E501 } read_only_vars = { @@ -109,12 +109,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, widgets, *args, **kwargs): # noqa: E501 - """DashboardContext - a model defined in OpenAPI + def _from_openapi_data(cls, conditions, enabled, *args, **kwargs): # noqa: E501 + """ObjectConditionalFormatting - a model defined in OpenAPI Args: - id (str): Dashboard object ID. - widgets ([WidgetDescriptor]): Widgets currently visible on the dashboard. + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -178,8 +178,8 @@ def _from_openapi_data(cls, id, widgets, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.widgets = widgets + self.conditions = conditions + self.enabled = enabled for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -200,12 +200,12 @@ def _from_openapi_data(cls, id, widgets, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, widgets, *args, **kwargs): # noqa: E501 - """DashboardContext - a model defined in OpenAPI + def __init__(self, conditions, enabled, *args, **kwargs): # noqa: E501 + """ObjectConditionalFormatting - a model defined in OpenAPI Args: - id (str): Dashboard object ID. - widgets ([WidgetDescriptor]): Widgets currently visible on the dashboard. + conditions ([ConditionalFormattingCondition]): Conditions evaluated in order; the first match wins. + enabled (bool): Whether the conditions are applied when rendering. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -267,8 +267,8 @@ def __init__(self, id, widgets, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.widgets = widgets + self.conditions = conditions + self.enabled = enabled 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/object_storage_info.py b/gooddata-api-client/gooddata_api_client/model/object_storage_info.py index 55014f18a..cedcc94ec 100644 --- a/gooddata-api-client/gooddata_api_client/model/object_storage_info.py +++ b/gooddata-api-client/gooddata_api_client/model/object_storage_info.py @@ -111,7 +111,7 @@ def _from_openapi_data(cls, name, storage_config, storage_id, storage_type, *arg """ObjectStorageInfo - a model defined in OpenAPI Args: - name (str): Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds. + name (str): Human-readable name. Pass `storageId` to ProvisionDatabase.storageIds. storage_config ({str: (str,)}): Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side. storage_id (str): Stable identifier of the storage configuration (UUID). storage_type (str): Provider type. @@ -206,7 +206,7 @@ def __init__(self, name, storage_config, storage_id, storage_type, *args, **kwar """ObjectStorageInfo - a model defined in OpenAPI Args: - name (str): Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds. + name (str): Human-readable name. Pass `storageId` to ProvisionDatabase.storageIds. storage_config ({str: (str,)}): Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side. storage_id (str): Stable identifier of the storage configuration (UUID). storage_type (str): Provider type. diff --git a/gooddata-api-client/gooddata_api_client/model/operation.py b/gooddata-api-client/gooddata_api_client/model/operation.py index 2db4832a0..5298a7261 100644 --- a/gooddata-api-client/gooddata_api_client/model/operation.py +++ b/gooddata-api-client/gooddata_api_client/model/operation.py @@ -68,10 +68,7 @@ class Operation(ModelNormal): 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", - 'CREATE-PIPE-TABLE': "create-pipe-table", - 'DELETE-PIPE-TABLE': "delete-pipe-table", 'ANALYZE-STATISTICS': "analyze-statistics", - 'REFRESH-PARTITION': "refresh-partition", }, } @@ -136,7 +133,7 @@ def _from_openapi_data(cls, id, kind, status, *args, **kwargs): # noqa: E501 Args: id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. status (str): Keyword Args: @@ -229,7 +226,7 @@ def __init__(self, id, kind, status, *args, **kwargs): # noqa: E501 Args: id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. status (str): Keyword Args: diff --git a/gooddata-api-client/gooddata_api_client/model/parameter_value.py b/gooddata-api-client/gooddata_api_client/model/parameter_value.py index 65beb630f..338190a6b 100644 --- a/gooddata-api-client/gooddata_api_client/model/parameter_value.py +++ b/gooddata-api-client/gooddata_api_client/model/parameter_value.py @@ -85,6 +85,7 @@ def openapi_types(): 'id': (str,), # noqa: E501 'title': (str,), # noqa: E501 'value': (str,), # noqa: E501 + 'value_title': (str,), # noqa: E501 } @cached_property @@ -96,6 +97,7 @@ def discriminator(): 'id': 'id', # noqa: E501 'title': 'title', # noqa: E501 'value': 'value', # noqa: E501 + 'value_title': 'valueTitle', # noqa: E501 } read_only_vars = { @@ -144,6 +146,7 @@ def _from_openapi_data(cls, id, title, value, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + value_title (str): Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -237,6 +240,7 @@ def __init__(self, id, title, value, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + value_title (str): Human-readable form of `value` (e.g. a constrained string's allowedValues title). Never used to drive execution. Falls back to `value` when absent.. [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/gooddata-api-client/gooddata_api_client/model/partition_config.py b/gooddata-api-client/gooddata_api_client/model/partition_config.py deleted file mode 100644 index b55a1bb59..000000000 --- a/gooddata-api-client/gooddata_api_client/model/partition_config.py +++ /dev/null @@ -1,273 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class PartitionConfig(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 { - 'type': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - val = { - } - if not val: - return None - return {'type': val} - - attribute_map = { - 'type': 'type', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, type, *args, **kwargs): # noqa: E501 - """PartitionConfig - a model defined in OpenAPI - - Args: - 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,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, type, *args, **kwargs): # noqa: E501 - """PartitionConfig - a model defined in OpenAPI - - Args: - 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,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/pending_operation.py b/gooddata-api-client/gooddata_api_client/model/pending_operation.py index fe3a5adc9..916b8db83 100644 --- a/gooddata-api-client/gooddata_api_client/model/pending_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/pending_operation.py @@ -67,10 +67,7 @@ class PendingOperation(ModelComposed): 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", - 'CREATE-PIPE-TABLE': "create-pipe-table", - 'DELETE-PIPE-TABLE': "delete-pipe-table", 'ANALYZE-STATISTICS': "analyze-statistics", - 'REFRESH-PARTITION': "refresh-partition", }, } @@ -130,7 +127,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "pending", must be one of ["pending", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -237,7 +234,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "pending", must be one of ["pending", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/gooddata-api-client/gooddata_api_client/model/pipe_table.py b/gooddata-api-client/gooddata_api_client/model/pipe_table.py deleted file mode 100644 index 819cff394..000000000 --- a/gooddata-api-client/gooddata_api_client/model/pipe_table.py +++ /dev/null @@ -1,346 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.column_info import ColumnInfo - from gooddata_api_client.model.create_pipe_table_request_distribution_config import CreatePipeTableRequestDistributionConfig - from gooddata_api_client.model.create_pipe_table_request_key_config import CreatePipeTableRequestKeyConfig - from gooddata_api_client.model.create_pipe_table_request_partition_config import CreatePipeTableRequestPartitionConfig - globals()['ColumnInfo'] = ColumnInfo - globals()['CreatePipeTableRequestDistributionConfig'] = CreatePipeTableRequestDistributionConfig - globals()['CreatePipeTableRequestKeyConfig'] = CreatePipeTableRequestKeyConfig - globals()['CreatePipeTableRequestPartitionConfig'] = CreatePipeTableRequestPartitionConfig - - -class PipeTable(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': ([ColumnInfo],), # noqa: E501 - 'database_name': (str,), # noqa: E501 - 'distribution_config': (CreatePipeTableRequestDistributionConfig,), # noqa: E501 - 'key_config': (CreatePipeTableRequestKeyConfig,), # noqa: E501 - 'partition_columns': ([str],), # noqa: E501 - 'path_prefix': (str,), # noqa: E501 - 'pipe_table_id': (str,), # noqa: E501 - 'polling_interval_seconds': (int,), # noqa: E501 - 'source_storage_name': (str,), # noqa: E501 - 'table_name': (str,), # noqa: E501 - 'table_properties': ({str: (str,)},), # noqa: E501 - 'partition_config': (CreatePipeTableRequestPartitionConfig,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'columns': 'columns', # noqa: E501 - 'database_name': 'databaseName', # noqa: E501 - 'distribution_config': 'distributionConfig', # noqa: E501 - 'key_config': 'keyConfig', # noqa: E501 - 'partition_columns': 'partitionColumns', # noqa: E501 - 'path_prefix': 'pathPrefix', # noqa: E501 - 'pipe_table_id': 'pipeTableId', # noqa: E501 - 'polling_interval_seconds': 'pollingIntervalSeconds', # noqa: E501 - 'source_storage_name': 'sourceStorageName', # noqa: E501 - 'table_name': 'tableName', # noqa: E501 - 'table_properties': 'tableProperties', # noqa: E501 - 'partition_config': 'partitionConfig', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, columns, database_name, distribution_config, key_config, partition_columns, path_prefix, pipe_table_id, polling_interval_seconds, source_storage_name, table_name, table_properties, *args, **kwargs): # noqa: E501 - """PipeTable - a model defined in OpenAPI - - Args: - columns ([ColumnInfo]): Inferred column schema - database_name (str): Database name - distribution_config (CreatePipeTableRequestDistributionConfig): - key_config (CreatePipeTableRequestKeyConfig): - partition_columns ([str]): Hive partition columns detected from the path structure - path_prefix (str): Path prefix to the parquet files - pipe_table_id (str): Internal UUID of the pipe table record - polling_interval_seconds (int): How often (in seconds) the pipe polls for new files. 0 = server default. - source_storage_name (str): Source ObjectStorage name - table_name (str): OLAP table name - table_properties ({str: (str,)}): CREATE TABLE PROPERTIES key-value pairs - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - partition_config (CreatePipeTableRequestPartitionConfig): [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.columns = columns - self.database_name = database_name - self.distribution_config = distribution_config - self.key_config = key_config - self.partition_columns = partition_columns - self.path_prefix = path_prefix - self.pipe_table_id = pipe_table_id - self.polling_interval_seconds = polling_interval_seconds - self.source_storage_name = source_storage_name - self.table_name = table_name - self.table_properties = table_properties - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, database_name, distribution_config, key_config, partition_columns, path_prefix, pipe_table_id, polling_interval_seconds, source_storage_name, table_name, table_properties, *args, **kwargs): # noqa: E501 - """PipeTable - a model defined in OpenAPI - - Args: - columns ([ColumnInfo]): Inferred column schema - database_name (str): Database name - distribution_config (CreatePipeTableRequestDistributionConfig): - key_config (CreatePipeTableRequestKeyConfig): - partition_columns ([str]): Hive partition columns detected from the path structure - path_prefix (str): Path prefix to the parquet files - pipe_table_id (str): Internal UUID of the pipe table record - polling_interval_seconds (int): How often (in seconds) the pipe polls for new files. 0 = server default. - source_storage_name (str): Source ObjectStorage name - table_name (str): OLAP table name - table_properties ({str: (str,)}): CREATE TABLE PROPERTIES key-value pairs - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - partition_config (CreatePipeTableRequestPartitionConfig): [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.columns = columns - self.database_name = database_name - self.distribution_config = distribution_config - self.key_config = key_config - self.partition_columns = partition_columns - self.path_prefix = path_prefix - self.pipe_table_id = pipe_table_id - self.polling_interval_seconds = polling_interval_seconds - self.source_storage_name = source_storage_name - self.table_name = table_name - self.table_properties = table_properties - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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 new file mode 100644 index 000000000..33edf7056 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/report_export_request.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.json_node import JsonNode + globals()['JsonNode'] = JsonNode + + +class ReportExportRequest(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 = { + ('format',): { + 'PDF': "PDF", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'file_name': (str,), # noqa: E501 + 'format': (str,), # noqa: E501 + 'report_id': (str,), # noqa: E501 + 'metadata': (JsonNode,), # noqa: E501 + 'timezone_id': (str, none_type,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'file_name': 'fileName', # noqa: E501 + 'format': 'format', # noqa: E501 + 'report_id': 'reportId', # noqa: E501 + 'metadata': 'metadata', # noqa: E501 + 'timezone_id': 'timezoneId', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, file_name, report_id, *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 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 + """ + + format = kwargs.get('format', "PDF") + _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.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 \ + 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, file_name, report_id, *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 + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + metadata (JsonNode): [optional] # noqa: E501 + timezone_id (str, none_type): Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.. [optional] # noqa: E501 + """ + + format = kwargs.get('format', "PDF") + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + 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 \ + 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/resolved_setting.py b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py index 6173e0ad2..84f5cd4b6 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_setting.py +++ b/gooddata-api-client/gooddata_api_client/model/resolved_setting.py @@ -102,10 +102,12 @@ class ResolvedSetting(ModelNormal): 'LDM_DEFAULT_LOCALE': "LDM_DEFAULT_LOCALE", 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS': "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", 'MAX_ZOOM_LEVEL': "MAX_ZOOM_LEVEL", + 'CONVERSATION_RETENTION_DAYS': "CONVERSATION_RETENTION_DAYS", 'SORT_CASE_SENSITIVE': "SORT_CASE_SENSITIVE", 'SORT_COLLATION': "SORT_COLLATION", 'METRIC_FORMAT_OVERRIDE': "METRIC_FORMAT_OVERRIDE", 'ENABLE_AI_ON_DATA': "ENABLE_AI_ON_DATA", + 'ENABLE_AI_DATA_OBFUSCATION': "ENABLE_AI_DATA_OBFUSCATION", 'ENABLE_PARTIAL_DATA_RESULTS': "ENABLE_PARTIAL_DATA_RESULTS", 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE': "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", 'ENABLE_NULL_JOINS': "ENABLE_NULL_JOINS", @@ -114,6 +116,11 @@ class ResolvedSetting(ModelNormal): 'RESTRICT_BASE_UI': "RESTRICT_BASE_UI", 'CERTIFY_PARENT_OBJECTS': "CERTIFY_PARENT_OBJECTS", 'HLL_TYPE': "HLL_TYPE", + 'ENABLE_TIMEZONE_CHANGE': "ENABLE_TIMEZONE_CHANGE", + 'AUTHORIZATION_SERVER_REDIRECT_POLICY': "AUTHORIZATION_SERVER_REDIRECT_POLICY", + 'DEFAULT_VISUALIZATION_VISIBILITY': "DEFAULT_VISUALIZATION_VISIBILITY", + 'DEFAULT_METRIC_VISIBILITY': "DEFAULT_METRIC_VISIBILITY", + 'GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE': "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE", }, } diff --git a/gooddata-api-client/gooddata_api_client/model/dim_attribute.py b/gooddata-api-client/gooddata_api_client/model/restricted_object.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/dim_attribute.py rename to gooddata-api-client/gooddata_api_client/model/restricted_object.py index f64d90fa1..787beb3ab 100644 --- a/gooddata-api-client/gooddata_api_client/model/dim_attribute.py +++ b/gooddata-api-client/gooddata_api_client/model/restricted_object.py @@ -31,7 +31,7 @@ -class DimAttribute(ModelNormal): +class RestrictedObject(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,7 +57,15 @@ class DimAttribute(ModelNormal): allowed_values = { ('type',): { + 'ANALYTICALDASHBOARD': "analyticalDashboard", 'ATTRIBUTE': "attribute", + 'ATTRIBUTEHIERARCHY': "attributeHierarchy", + 'COMPUTEDATTRIBUTE': "computedAttribute", + 'FACT': "fact", + 'LABEL': "label", + 'METRIC': "metric", + 'USERDATAFILTER': "userDataFilter", + 'VISUALIZATIONOBJECT': "visualizationObject", }, } @@ -86,7 +94,6 @@ def openapi_types(): """ return { 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 'type': (str,), # noqa: E501 } @@ -97,7 +104,6 @@ def discriminator(): attribute_map = { 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 'type': 'type', # noqa: E501 } @@ -108,15 +114,14 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 - """DimAttribute - a model defined in OpenAPI + def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 + """RestrictedObject - a model defined in OpenAPI Args: - id (str): ID of the object - title (str): Title of attribute. + id (str): Object identifier, unique within one workspace hierarchy. + type (str): JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`. Keyword Args: - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # 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. @@ -149,7 +154,6 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ - type = kwargs.get('type', "attribute") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -180,7 +184,6 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.id = id - self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ @@ -202,15 +205,14 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, title, *args, **kwargs): # noqa: E501 - """DimAttribute - a model defined in OpenAPI + def __init__(self, id, type, *args, **kwargs): # noqa: E501 + """RestrictedObject - a model defined in OpenAPI Args: - id (str): ID of the object - title (str): Title of attribute. + id (str): Object identifier, unique within one workspace hierarchy. + type (str): JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`. Keyword Args: - type (str): Object type. defaults to "attribute", must be one of ["attribute", ] # 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. @@ -243,7 +245,6 @@ def __init__(self, id, title, *args, **kwargs): # noqa: E501 _visited_composed_classes = (Animal,) """ - type = kwargs.get('type', "attribute") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -272,7 +273,6 @@ def __init__(self, id, title, *args, **kwargs): # noqa: E501 self._visited_composed_classes = _visited_composed_classes + (self.__class__,) self.id = id - self.title = title self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ diff --git a/gooddata-api-client/gooddata_api_client/model/route_result.py b/gooddata-api-client/gooddata_api_client/model/route_result.py deleted file mode 100644 index 1e0194fe9..000000000 --- a/gooddata-api-client/gooddata_api_client/model/route_result.py +++ /dev/null @@ -1,286 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class RouteResult(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 = { - ('use_case',): { - 'INVALID': "INVALID", - 'GENERAL': "GENERAL", - 'SEARCH': "SEARCH", - 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", - 'EXTEND_VISUALIZATION': "EXTEND_VISUALIZATION", - 'HOWTO': "HOWTO", - 'CHANGE_ANALYSIS': "CHANGE_ANALYSIS", - 'ALERT': "ALERT", - }, - } - - 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 { - 'reasoning': (str,), # noqa: E501 - 'use_case': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'reasoning': 'reasoning', # noqa: E501 - 'use_case': 'useCase', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, reasoning, use_case, *args, **kwargs): # noqa: E501 - """RouteResult - a model defined in OpenAPI - - Args: - reasoning (str): Explanation why LLM picked this use case. - use_case (str): Use case where LLM routed based on question. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.reasoning = reasoning - self.use_case = use_case - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, reasoning, use_case, *args, **kwargs): # noqa: E501 - """RouteResult - a model defined in OpenAPI - - Args: - reasoning (str): Explanation why LLM picked this use case. - use_case (str): Use case where LLM routed based on question. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.reasoning = reasoning - self.use_case = use_case - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/saved_visualization.py b/gooddata-api-client/gooddata_api_client/model/saved_visualization.py deleted file mode 100644 index f97c45546..000000000 --- a/gooddata-api-client/gooddata_api_client/model/saved_visualization.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SavedVisualization(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 { - 'created_visualization_id': (str,), # noqa: E501 - 'saved_visualization_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'created_visualization_id': 'createdVisualizationId', # noqa: E501 - 'saved_visualization_id': 'savedVisualizationId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, created_visualization_id, saved_visualization_id, *args, **kwargs): # noqa: E501 - """SavedVisualization - a model defined in OpenAPI - - Args: - created_visualization_id (str): Created visualization ID. - saved_visualization_id (str): Saved visualization ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.created_visualization_id = created_visualization_id - self.saved_visualization_id = saved_visualization_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, created_visualization_id, saved_visualization_id, *args, **kwargs): # noqa: E501 - """SavedVisualization - a model defined in OpenAPI - - Args: - created_visualization_id (str): Created visualization ID. - saved_visualization_id (str): Saved visualization ID. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.created_visualization_id = created_visualization_id - self.saved_visualization_id = saved_visualization_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/search_relationship_object.py b/gooddata-api-client/gooddata_api_client/model/search_relationship_object.py deleted file mode 100644 index 29db5456f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/search_relationship_object.py +++ /dev/null @@ -1,312 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class SearchRelationshipObject(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 { - 'source_object_id': (str,), # noqa: E501 - 'source_object_title': (str,), # noqa: E501 - 'source_object_type': (str,), # noqa: E501 - 'source_workspace_id': (str,), # noqa: E501 - 'target_object_id': (str,), # noqa: E501 - 'target_object_title': (str,), # noqa: E501 - 'target_object_type': (str,), # noqa: E501 - 'target_workspace_id': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'source_object_id': 'sourceObjectId', # noqa: E501 - 'source_object_title': 'sourceObjectTitle', # noqa: E501 - 'source_object_type': 'sourceObjectType', # noqa: E501 - 'source_workspace_id': 'sourceWorkspaceId', # noqa: E501 - 'target_object_id': 'targetObjectId', # noqa: E501 - 'target_object_title': 'targetObjectTitle', # noqa: E501 - 'target_object_type': 'targetObjectType', # noqa: E501 - 'target_workspace_id': 'targetWorkspaceId', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, source_object_id, source_object_title, source_object_type, source_workspace_id, target_object_id, target_object_title, target_object_type, target_workspace_id, *args, **kwargs): # noqa: E501 - """SearchRelationshipObject - a model defined in OpenAPI - - Args: - source_object_id (str): Source object ID. - source_object_title (str): Source object title. - source_object_type (str): Source object type, e.g. dashboard. - source_workspace_id (str): Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located. - target_object_id (str): Target object ID. - target_object_title (str): Target object title. - target_object_type (str): Target object type, e.g. visualization. - target_workspace_id (str): Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.source_object_id = source_object_id - self.source_object_title = source_object_title - self.source_object_type = source_object_type - self.source_workspace_id = source_workspace_id - self.target_object_id = target_object_id - self.target_object_title = target_object_title - self.target_object_type = target_object_type - self.target_workspace_id = target_workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, source_object_id, source_object_title, source_object_type, source_workspace_id, target_object_id, target_object_title, target_object_type, target_workspace_id, *args, **kwargs): # noqa: E501 - """SearchRelationshipObject - a model defined in OpenAPI - - Args: - source_object_id (str): Source object ID. - source_object_title (str): Source object title. - source_object_type (str): Source object type, e.g. dashboard. - source_workspace_id (str): Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located. - target_object_id (str): Target object ID. - target_object_title (str): Target object title. - target_object_type (str): Target object type, e.g. visualization. - target_workspace_id (str): Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.source_object_id = source_object_id - self.source_object_title = source_object_title - self.source_object_type = source_object_type - self.source_workspace_id = source_workspace_id - self.target_object_id = target_object_id - self.target_object_title = target_object_title - self.target_object_type = target_object_type - self.target_workspace_id = target_workspace_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/search_request.py b/gooddata-api-client/gooddata_api_client/model/search_request.py deleted file mode 100644 index 5062c9e3f..000000000 --- a/gooddata-api-client/gooddata_api_client/model/search_request.py +++ /dev/null @@ -1,329 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.allowed_relationship_type import AllowedRelationshipType - globals()['AllowedRelationshipType'] = AllowedRelationshipType - - -class SearchRequest(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 = { - ('object_types',): { - 'ATTRIBUTE': "attribute", - 'METRIC': "metric", - 'FACT': "fact", - 'LABEL': "label", - 'DATE': "date", - 'DATASET': "dataset", - 'VISUALIZATION': "visualization", - 'DASHBOARD': "dashboard", - }, - } - - validations = { - ('question',): { - 'max_length': 1000, - }, - } - - @cached_property - def additional_properties_type(): - """ - 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 { - 'question': (str,), # noqa: E501 - 'allowed_relationship_types': ([AllowedRelationshipType],), # noqa: E501 - 'deep_search': (bool,), # noqa: E501 - 'enable_hybrid_search': (bool,), # noqa: E501 - 'exclude_tags': ([str],), # noqa: E501 - 'include_hidden': (bool,), # noqa: E501 - 'include_tags': ([str],), # noqa: E501 - 'limit': (int,), # noqa: E501 - 'object_types': ([str],), # noqa: E501 - 'relevant_score_threshold': (float,), # noqa: E501 - 'title_to_descriptor_ratio': (float,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'question': 'question', # noqa: E501 - 'allowed_relationship_types': 'allowedRelationshipTypes', # noqa: E501 - 'deep_search': 'deepSearch', # noqa: E501 - 'enable_hybrid_search': 'enableHybridSearch', # noqa: E501 - 'exclude_tags': 'excludeTags', # noqa: E501 - 'include_hidden': 'includeHidden', # noqa: E501 - 'include_tags': 'includeTags', # noqa: E501 - 'limit': 'limit', # noqa: E501 - 'object_types': 'objectTypes', # noqa: E501 - 'relevant_score_threshold': 'relevantScoreThreshold', # noqa: E501 - 'title_to_descriptor_ratio': 'titleToDescriptorRatio', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, question, *args, **kwargs): # noqa: E501 - """SearchRequest - a model defined in OpenAPI - - Args: - question (str): Keyword/sentence is input for search. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_relationship_types ([AllowedRelationshipType]): Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.. [optional] # noqa: E501 - deep_search (bool): Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.. [optional] if omitted the server will use the default value of False # noqa: E501 - enable_hybrid_search (bool): If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.. [optional] if omitted the server will use the default value of False # noqa: E501 - exclude_tags ([str]): Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.. [optional] # noqa: E501 - include_hidden (bool): If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.. [optional] if omitted the server will use the default value of False # noqa: E501 - include_tags ([str]): Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.. [optional] # noqa: E501 - limit (int): Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.. [optional] if omitted the server will use the default value of 10 # noqa: E501 - object_types ([str]): List of object types to search for.. [optional] # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.3 # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - """ - - _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.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, question, *args, **kwargs): # noqa: E501 - """SearchRequest - a model defined in OpenAPI - - Args: - question (str): Keyword/sentence is input for search. - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - allowed_relationship_types ([AllowedRelationshipType]): Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.. [optional] # noqa: E501 - deep_search (bool): Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.. [optional] if omitted the server will use the default value of False # noqa: E501 - enable_hybrid_search (bool): If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.. [optional] if omitted the server will use the default value of False # noqa: E501 - exclude_tags ([str]): Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.. [optional] # noqa: E501 - include_hidden (bool): If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.. [optional] if omitted the server will use the default value of False # noqa: E501 - include_tags ([str]): Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.. [optional] # noqa: E501 - limit (int): Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.. [optional] if omitted the server will use the default value of 10 # noqa: E501 - object_types ([str]): List of object types to search for.. [optional] # noqa: E501 - relevant_score_threshold (float): Score, above which we return found objects. Below this score objects are not relevant.. [optional] if omitted the server will use the default value of 0.3 # noqa: E501 - title_to_descriptor_ratio (float): Temporary for experiments. Ratio of title score to descriptor score.. [optional] if omitted the server will use the default value of 0.7 # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.question = question - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/set_certification_request.py b/gooddata-api-client/gooddata_api_client/model/set_certification_request.py index 2d9637ae2..18a56d17c 100644 --- a/gooddata-api-client/gooddata_api_client/model/set_certification_request.py +++ b/gooddata-api-client/gooddata_api_client/model/set_certification_request.py @@ -60,6 +60,7 @@ class SetCertificationRequest(ModelNormal): 'METRIC': "metric", 'VISUALIZATIONOBJECT': "visualizationObject", 'ANALYTICALDASHBOARD': "analyticalDashboard", + 'COMPUTEDATTRIBUTE': "computedAttribute", }, ('status',): { 'None': None, diff --git a/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter.py b/gooddata-api-client/gooddata_api_client/model/sql_flow_input.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter.py rename to gooddata-api-client/gooddata_api_client/model/sql_flow_input.py index 459e0403d..b4584fd2b 100644 --- a/gooddata-api-client/gooddata_api_client/model/gen_ai_ranking_filter.py +++ b/gooddata-api-client/gooddata_api_client/model/sql_flow_input.py @@ -31,13 +31,11 @@ def lazy_import(): - from gooddata_api_client.model.filter import Filter - from gooddata_api_client.model.gen_ai_ranking_filter_all_of import GenAiRankingFilterAllOf - globals()['Filter'] = Filter - globals()['GenAiRankingFilterAllOf'] = GenAiRankingFilterAllOf + from gooddata_api_client.model.sql_flow_input_all_of import SqlFlowInputAllOf + globals()['SqlFlowInputAllOf'] = SqlFlowInputAllOf -class GenAiRankingFilter(ModelComposed): +class SqlFlowInput(ModelComposed): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -62,9 +60,8 @@ class GenAiRankingFilter(ModelComposed): """ allowed_values = { - ('operator',): { - 'TOP': "TOP", - 'BOTTOM': "BOTTOM", + ('type',): { + 'SQL': "sql", }, } @@ -94,10 +91,9 @@ def openapi_types(): """ lazy_import() return { - 'measures': ([str],), # noqa: E501 - 'operator': (str,), # noqa: E501 - 'value': (int,), # noqa: E501 - 'dimensionality': ([str],), # noqa: E501 + 'data_source_id': (str,), # noqa: E501 + 'sql': (str,), # noqa: E501 + 'type': (str,), # noqa: E501 } @cached_property @@ -106,10 +102,9 @@ def discriminator(): attribute_map = { - 'measures': 'measures', # noqa: E501 - 'operator': 'operator', # noqa: E501 - 'value': 'value', # noqa: E501 - 'dimensionality': 'dimensionality', # noqa: E501 + 'data_source_id': 'dataSourceId', # noqa: E501 + 'sql': 'sql', # noqa: E501 + 'type': 'type', # noqa: E501 } read_only_vars = { @@ -118,12 +113,12 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """GenAiRankingFilter - a model defined in OpenAPI + """SqlFlowInput - a model defined in OpenAPI Keyword Args: - measures ([str]): - operator (str): - value (int): + data_source_id (str): Identifier of the data source that runs the statement. + sql (str): One SELECT statement in the SQL dialect of the data source. + type (str): Type of the input.. defaults to "sql", must be one of ["sql", ] # 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. @@ -154,9 +149,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dimensionality ([str]): [optional] # noqa: E501 """ + type = kwargs.get('type', "sql") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -225,12 +220,12 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """GenAiRankingFilter - a model defined in OpenAPI + """SqlFlowInput - a model defined in OpenAPI Keyword Args: - measures ([str]): - operator (str): - value (int): + data_source_id (str): Identifier of the data source that runs the statement. + sql (str): One SELECT statement in the SQL dialect of the data source. + type (str): Type of the input.. defaults to "sql", must be one of ["sql", ] # 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. @@ -261,9 +256,9 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - dimensionality ([str]): [optional] # noqa: E501 """ + type = kwargs.get('type', "sql") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -331,8 +326,7 @@ def _composed_schemas(): 'anyOf': [ ], 'allOf': [ - Filter, - GenAiRankingFilterAllOf, + SqlFlowInputAllOf, ], 'oneOf': [ ], diff --git a/gooddata-api-client/gooddata_api_client/model/primary_key_config.py b/gooddata-api-client/gooddata_api_client/model/sql_flow_input_all_of.py similarity index 91% rename from gooddata-api-client/gooddata_api_client/model/primary_key_config.py rename to gooddata-api-client/gooddata_api_client/model/sql_flow_input_all_of.py index eaeed54e9..0ddc8422b 100644 --- a/gooddata-api-client/gooddata_api_client/model/primary_key_config.py +++ b/gooddata-api-client/gooddata_api_client/model/sql_flow_input_all_of.py @@ -31,7 +31,7 @@ -class PrimaryKeyConfig(ModelNormal): +class SqlFlowInputAllOf(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -57,7 +57,7 @@ class PrimaryKeyConfig(ModelNormal): allowed_values = { ('type',): { - 'PRIMARY': "primary", + 'SQL': "sql", }, } @@ -85,8 +85,9 @@ def openapi_types(): and the value is attribute type. """ return { + 'data_source_id': (str,), # noqa: E501 + 'sql': (str,), # noqa: E501 'type': (str,), # noqa: E501 - 'columns': ([str],), # noqa: E501 } @cached_property @@ -95,8 +96,9 @@ def discriminator(): attribute_map = { + 'data_source_id': 'dataSourceId', # noqa: E501 + 'sql': 'sql', # noqa: E501 'type': 'type', # noqa: E501 - 'columns': 'columns', # noqa: E501 } read_only_vars = { @@ -107,12 +109,9 @@ def discriminator(): @classmethod @convert_js_args_to_python_args def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """PrimaryKeyConfig - a model defined in OpenAPI - - Args: + """SqlFlowInputAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "primary", must be one of ["primary", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -143,10 +142,11 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + data_source_id (str): Identifier of the data source that runs the statement.. [optional] # noqa: E501 + sql (str): One SELECT statement in the SQL dialect of the data source.. [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "sql" # noqa: E501 """ - type = kwargs.get('type', "primary") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', True) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -176,7 +176,6 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -198,12 +197,9 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 @convert_js_args_to_python_args def __init__(self, *args, **kwargs): # noqa: E501 - """PrimaryKeyConfig - a model defined in OpenAPI - - Args: + """SqlFlowInputAllOf - a model defined in OpenAPI Keyword Args: - type (str): defaults to "primary", must be one of ["primary", ] # noqa: E501 _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -234,10 +230,11 @@ def __init__(self, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 + data_source_id (str): Identifier of the data source that runs the statement.. [optional] # noqa: E501 + sql (str): One SELECT statement in the SQL dialect of the data source.. [optional] # noqa: E501 + type (str): Type of the input.. [optional] if omitted the server will use the default value of "sql" # noqa: E501 """ - type = kwargs.get('type', "primary") _check_type = kwargs.pop('_check_type', True) _spec_property_naming = kwargs.pop('_spec_property_naming', False) _path_to_item = kwargs.pop('_path_to_item', ()) @@ -265,7 +262,6 @@ def __init__(self, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.type = type for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py index a4446394c..c23a75055 100644 --- a/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py +++ b/gooddata-api-client/gooddata_api_client/model/succeeded_operation.py @@ -69,10 +69,7 @@ class SucceededOperation(ModelComposed): 'PROVISION-DATABASE': "provision-database", 'DEPROVISION-DATABASE': "deprovision-database", 'RUN-SERVICE-COMMAND': "run-service-command", - 'CREATE-PIPE-TABLE': "create-pipe-table", - 'DELETE-PIPE-TABLE': "delete-pipe-table", 'ANALYZE-STATISTICS': "analyze-statistics", - 'REFRESH-PARTITION': "refresh-partition", }, } @@ -134,7 +131,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "succeeded", must be one of ["succeeded", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. @@ -242,7 +239,7 @@ def __init__(self, *args, **kwargs): # noqa: E501 Keyword Args: status (str): defaults to "succeeded", must be one of ["succeeded", ] # noqa: E501 id (str): Id of the operation - kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. * `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3). + kind (str): Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection. _check_type (bool): if True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. diff --git a/gooddata-api-client/gooddata_api_client/model/suggestion.py b/gooddata-api-client/gooddata_api_client/model/suggestion.py deleted file mode 100644 index c69045453..000000000 --- a/gooddata-api-client/gooddata_api_client/model/suggestion.py +++ /dev/null @@ -1,276 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class Suggestion(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 - 'query': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'label': 'label', # noqa: E501 - 'query': 'query', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, label, query, *args, **kwargs): # noqa: E501 - """Suggestion - a model defined in OpenAPI - - Args: - label (str): Suggestion button label - query (str): Suggestion query - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.query = query - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, query, *args, **kwargs): # noqa: E501 - """Suggestion - a model defined in OpenAPI - - Args: - label (str): Suggestion button label - query (str): Suggestion query - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.query = query - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py index 92735cd43..b5532381c 100644 --- a/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py +++ b/gooddata-api-client/gooddata_api_client/model/tabular_export_request.py @@ -31,12 +31,14 @@ def lazy_import(): + from gooddata_api_client.model.conditional_formatting import ConditionalFormatting from gooddata_api_client.model.custom_override import CustomOverride from gooddata_api_client.model.execution_settings import ExecutionSettings from gooddata_api_client.model.json_node import JsonNode from gooddata_api_client.model.parameter_value import ParameterValue from gooddata_api_client.model.settings import Settings from gooddata_api_client.model.tabular_export_execution import TabularExportExecution + globals()['ConditionalFormatting'] = ConditionalFormatting globals()['CustomOverride'] = CustomOverride globals()['ExecutionSettings'] = ExecutionSettings globals()['JsonNode'] = JsonNode @@ -106,6 +108,7 @@ def openapi_types(): return { 'file_name': (str,), # noqa: E501 'format': (str,), # noqa: E501 + 'conditional_formatting': (ConditionalFormatting,), # noqa: E501 'custom_override': (CustomOverride,), # noqa: E501 'execution_result': (str,), # noqa: E501 'execution_settings': (ExecutionSettings,), # noqa: E501 @@ -126,6 +129,7 @@ def discriminator(): attribute_map = { 'file_name': 'fileName', # noqa: E501 'format': 'format', # noqa: E501 + 'conditional_formatting': 'conditionalFormatting', # noqa: E501 'custom_override': 'customOverride', # noqa: E501 'execution_result': 'executionResult', # noqa: E501 'execution_settings': 'executionSettings', # noqa: E501 @@ -183,6 +187,7 @@ def _from_openapi_data(cls, file_name, format, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 execution_settings (ExecutionSettings): [optional] # noqa: E501 @@ -284,6 +289,7 @@ def __init__(self, file_name, format, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) + conditional_formatting (ConditionalFormatting): [optional] # noqa: E501 custom_override (CustomOverride): [optional] # noqa: E501 execution_result (str): Execution result identifier.. [optional] # noqa: E501 execution_settings (ExecutionSettings): [optional] # noqa: E501 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 f09d76165..e2271ddd3 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 @@ -88,6 +88,7 @@ class TestDefinitionRequest(ModelNormal): 'CRATEDB': "CRATEDB", 'AILAKEHOUSE': "AILAKEHOUSE", 'DENODO': "DENODO", + 'TRINO': "TRINO", }, ('authentication_type',): { 'None': None, diff --git a/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py b/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py deleted file mode 100644 index 7a960ff69..000000000 --- a/gooddata-api-client/gooddata_api_client/model/time_slice_partition_config.py +++ /dev/null @@ -1,308 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class TimeSlicePartitionConfig(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',): { - 'TIMESLICE': "timeSlice", - }, - ('unit',): { - 'YEAR': "year", - 'QUARTER': "quarter", - 'MONTH': "month", - 'WEEK': "week", - 'DAY': "day", - 'HOUR': "hour", - 'MINUTE': "minute", - 'SECOND': "second", - 'MILLISECOND': "millisecond", - 'MICROSECOND': "microsecond", - }, - } - - validations = { - ('slices',): { - '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 { - 'column': (str,), # noqa: E501 - 'slices': (int,), # noqa: E501 - 'type': (str,), # noqa: E501 - 'unit': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'column': 'column', # noqa: E501 - 'slices': 'slices', # noqa: E501 - 'type': 'type', # noqa: E501 - 'unit': 'unit', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, column, slices, unit, *args, **kwargs): # noqa: E501 - """TimeSlicePartitionConfig - a model defined in OpenAPI - - Args: - column (str): Column to partition on. - slices (int): How many units per slice. - unit (str): Date/time unit for partition granularity - - Keyword Args: - type (str): defaults to "timeSlice", must be one of ["timeSlice", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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', "timeSlice") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.slices = slices - self.type = type - self.unit = unit - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, column, slices, unit, *args, **kwargs): # noqa: E501 - """TimeSlicePartitionConfig - a model defined in OpenAPI - - Args: - column (str): Column to partition on. - slices (int): How many units per slice. - unit (str): Date/time unit for partition granularity - - Keyword Args: - type (str): defaults to "timeSlice", must be one of ["timeSlice", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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', "timeSlice") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.column = column - self.slices = slices - self.type = type - self.unit = unit - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/unique_key_config.py b/gooddata-api-client/gooddata_api_client/model/unique_key_config.py deleted file mode 100644 index 60a315fd5..000000000 --- a/gooddata-api-client/gooddata_api_client/model/unique_key_config.py +++ /dev/null @@ -1,279 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class UniqueKeyConfig(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',): { - 'UNIQUE': "unique", - }, - } - - validations = { - } - - @cached_property - def additional_properties_type(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - """ - return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 - - _nullable = False - - @cached_property - def openapi_types(): - """ - This must be a method because a model may have properties that are - of type self, this must run after the class is loaded - - Returns - openapi_types (dict): The key is attribute name - and the value is attribute type. - """ - return { - 'type': (str,), # noqa: E501 - 'columns': ([str],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'type': 'type', # noqa: E501 - 'columns': 'columns', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """UniqueKeyConfig - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): defaults to "unique", must be one of ["unique", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "unique") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, *args, **kwargs): # noqa: E501 - """UniqueKeyConfig - a model defined in OpenAPI - - Args: - - Keyword Args: - type (str): defaults to "unique", must be one of ["unique", ] # noqa: E501 - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - columns ([str]): Key columns. Defaults to first inferred column.. [optional] # noqa: E501 - """ - - type = kwargs.get('type', "unique") - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.type = type - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/user_context.py b/gooddata-api-client/gooddata_api_client/model/user_context.py deleted file mode 100644 index b6da0487b..000000000 --- a/gooddata-api-client/gooddata_api_client/model/user_context.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification - from gooddata_api_client.model.object_reference_group import ObjectReferenceGroup - from gooddata_api_client.model.ui_context import UIContext - globals()['ActiveObjectIdentification'] = ActiveObjectIdentification - globals()['ObjectReferenceGroup'] = ObjectReferenceGroup - globals()['UIContext'] = UIContext - - -class UserContext(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 { - 'active_object': (ActiveObjectIdentification,), # noqa: E501 - 'referenced_objects': ([ObjectReferenceGroup],), # noqa: E501 - 'view': (UIContext,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'active_object': 'activeObject', # noqa: E501 - 'referenced_objects': 'referencedObjects', # noqa: E501 - 'view': 'view', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """UserContext - 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,) - active_object (ActiveObjectIdentification): [optional] # noqa: E501 - referenced_objects ([ObjectReferenceGroup]): Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).. [optional] # noqa: E501 - view (UIContext): [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 - """UserContext - 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,) - active_object (ActiveObjectIdentification): [optional] # noqa: E501 - referenced_objects ([ObjectReferenceGroup]): Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).. [optional] # noqa: E501 - view (UIContext): [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/user_management_workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py index 1a41bd4b1..e6f5fab96 100644 --- a/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/user_management_workspace_permission_assignment.py @@ -68,6 +68,7 @@ class UserManagementWorkspacePermissionAssignment(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", @@ -84,6 +85,7 @@ class UserManagementWorkspacePermissionAssignment(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", diff --git a/gooddata-api-client/gooddata_api_client/model/validate_by_item.py b/gooddata-api-client/gooddata_api_client/model/validate_by_item.py index 0ce8015d4..6fb113b12 100644 --- a/gooddata-api-client/gooddata_api_client/model/validate_by_item.py +++ b/gooddata-api-client/gooddata_api_client/model/validate_by_item.py @@ -61,7 +61,7 @@ class ValidateByItem(ModelNormal): validations = { ('type',): { 'regex': { - 'pattern': r'^(label)|(attribute)|(fact)|(metric)$', # noqa: E501 + 'pattern': r'^(label|attribute|computedAttribute|fact|metric)$', # noqa: E501 }, }, } @@ -113,7 +113,7 @@ def _from_openapi_data(cls, id, type, *args, **kwargs): # noqa: E501 Args: id (str): Specifies entity used for valid elements computation. - type (str): Specifies entity type which could be label, attribute, fact, or metric. + type (str): Specifies entity type which could be label, attribute, computedAttribute, fact, or metric. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -204,7 +204,7 @@ def __init__(self, id, type, *args, **kwargs): # noqa: E501 Args: id (str): Specifies entity used for valid elements computation. - type (str): Specifies entity type which could be label, attribute, fact, or metric. + type (str): Specifies entity type which could be label, attribute, computedAttribute, fact, or metric. Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_config.py b/gooddata-api-client/gooddata_api_client/model/visualization_config.py deleted file mode 100644 index 56afa4fe1..000000000 --- a/gooddata-api-client/gooddata_api_client/model/visualization_config.py +++ /dev/null @@ -1,288 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.anomaly_detection_config import AnomalyDetectionConfig - from gooddata_api_client.model.clustering_config import ClusteringConfig - from gooddata_api_client.model.forecast_config import ForecastConfig - from gooddata_api_client.model.what_if_scenario_config import WhatIfScenarioConfig - globals()['AnomalyDetectionConfig'] = AnomalyDetectionConfig - globals()['ClusteringConfig'] = ClusteringConfig - globals()['ForecastConfig'] = ForecastConfig - globals()['WhatIfScenarioConfig'] = WhatIfScenarioConfig - - -class VisualizationConfig(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 { - 'anomaly_detection': (AnomalyDetectionConfig,), # noqa: E501 - 'clustering': (ClusteringConfig,), # noqa: E501 - 'forecast': (ForecastConfig,), # noqa: E501 - 'what_if': (WhatIfScenarioConfig,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'anomaly_detection': 'anomalyDetection', # noqa: E501 - 'clustering': 'clustering', # noqa: E501 - 'forecast': 'forecast', # noqa: E501 - 'what_if': 'whatIf', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 - """VisualizationConfig - 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,) - anomaly_detection (AnomalyDetectionConfig): [optional] # noqa: E501 - clustering (ClusteringConfig): [optional] # noqa: E501 - forecast (ForecastConfig): [optional] # noqa: E501 - what_if (WhatIfScenarioConfig): [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 - """VisualizationConfig - 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,) - anomaly_detection (AnomalyDetectionConfig): [optional] # noqa: E501 - clustering (ClusteringConfig): [optional] # noqa: E501 - forecast (ForecastConfig): [optional] # noqa: E501 - what_if (WhatIfScenarioConfig): [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/visualization_permissions.py b/gooddata-api-client/gooddata_api_client/model/visualization_permissions.py new file mode 100644 index 000000000..00379f03b --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_permissions.py @@ -0,0 +1,292 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.rule_permission import RulePermission + from gooddata_api_client.model.user_group_permission import UserGroupPermission + from gooddata_api_client.model.user_permission import UserPermission + globals()['RulePermission'] = RulePermission + globals()['UserGroupPermission'] = UserGroupPermission + globals()['UserPermission'] = UserPermission + + +class VisualizationPermissions(ModelNormal): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'rules': ([RulePermission],), # noqa: E501 + 'user_groups': ([UserGroupPermission],), # noqa: E501 + 'users': ([UserPermission],), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'rules': 'rules', # noqa: E501 + 'user_groups': 'userGroups', # noqa: E501 + 'users': 'users', # noqa: E501 + } + + read_only_vars = { + } + + _composed_schemas = {} + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, rules, user_groups, users, *args, **kwargs): # noqa: E501 + """VisualizationPermissions - a model defined in OpenAPI + + Args: + rules ([RulePermission]): List of rules + user_groups ([UserGroupPermission]): List of user groups + users ([UserPermission]): List of users + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', True) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.rules = rules + self.user_groups = user_groups + self.users = users + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + ]) + + @convert_js_args_to_python_args + def __init__(self, rules, user_groups, users, *args, **kwargs): # noqa: E501 + """VisualizationPermissions - a model defined in OpenAPI + + Args: + rules ([RulePermission]): List of rules + user_groups ([UserGroupPermission]): List of user groups + users ([UserPermission]): List of users + + Keyword Args: + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + self.rules = rules + self.user_groups = user_groups + self.users = users + for var_name, var_value in kwargs.items(): + if var_name not in self.attribute_map and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self.additional_properties_type is None: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/resolved_llm.py b/gooddata-api-client/gooddata_api_client/model/visualization_permissions_assignment.py similarity index 93% rename from gooddata-api-client/gooddata_api_client/model/resolved_llm.py rename to gooddata-api-client/gooddata_api_client/model/visualization_permissions_assignment.py index 27593b986..5f346ff2c 100644 --- a/gooddata-api-client/gooddata_api_client/model/resolved_llm.py +++ b/gooddata-api-client/gooddata_api_client/model/visualization_permissions_assignment.py @@ -31,7 +31,7 @@ -class ResolvedLlm(ModelNormal): +class VisualizationPermissionsAssignment(ModelNormal): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech @@ -56,6 +56,11 @@ class ResolvedLlm(ModelNormal): """ allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, } validations = { @@ -82,8 +87,7 @@ def openapi_types(): and the value is attribute type. """ return { - 'id': (str,), # noqa: E501 - 'title': (str,), # noqa: E501 + 'permissions': ([str],), # noqa: E501 } @cached_property @@ -92,8 +96,7 @@ def discriminator(): attribute_map = { - 'id': 'id', # noqa: E501 - 'title': 'title', # noqa: E501 + 'permissions': 'permissions', # noqa: E501 } read_only_vars = { @@ -103,12 +106,11 @@ def discriminator(): @classmethod @convert_js_args_to_python_args - def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 - """ResolvedLlm - a model defined in OpenAPI + def _from_openapi_data(cls, permissions, *args, **kwargs): # noqa: E501 + """VisualizationPermissionsAssignment - a model defined in OpenAPI Args: - id (str): - title (str): + permissions ([str]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -172,8 +174,7 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.title = title + self.permissions = permissions for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ @@ -194,12 +195,11 @@ def _from_openapi_data(cls, id, title, *args, **kwargs): # noqa: E501 ]) @convert_js_args_to_python_args - def __init__(self, id, title, *args, **kwargs): # noqa: E501 - """ResolvedLlm - a model defined in OpenAPI + def __init__(self, permissions, *args, **kwargs): # noqa: E501 + """VisualizationPermissionsAssignment - a model defined in OpenAPI Args: - id (str): - title (str): + permissions ([str]): Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -261,8 +261,7 @@ def __init__(self, id, title, *args, **kwargs): # noqa: E501 self._configuration = _configuration self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - self.id = id - self.title = title + self.permissions = permissions for var_name, var_value in kwargs.items(): if var_name not in self.attribute_map and \ self._configuration is not None and \ diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee.py b/gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee.py new file mode 100644 index 000000000..fbdb28af3 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee.py @@ -0,0 +1,334 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.assignee_identifier import AssigneeIdentifier + from gooddata_api_client.model.attribute_permissions_for_assignee_all_of import AttributePermissionsForAssigneeAllOf + from gooddata_api_client.model.visualization_permissions_assignment import VisualizationPermissionsAssignment + globals()['AssigneeIdentifier'] = AssigneeIdentifier + globals()['AttributePermissionsForAssigneeAllOf'] = AttributePermissionsForAssigneeAllOf + globals()['VisualizationPermissionsAssignment'] = VisualizationPermissionsAssignment + + +class VisualizationPermissionsForAssignee(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'permissions': ([str],), # noqa: E501 + 'assignee_identifier': (AssigneeIdentifier,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_identifier': 'assigneeIdentifier', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VisualizationPermissionsForAssignee - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_identifier (AssigneeIdentifier): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VisualizationPermissionsForAssignee - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_identifier (AssigneeIdentifier): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + AttributePermissionsForAssigneeAllOf, + VisualizationPermissionsAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee_rule.py b/gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee_rule.py new file mode 100644 index 000000000..340a0ec69 --- /dev/null +++ b/gooddata-api-client/gooddata_api_client/model/visualization_permissions_for_assignee_rule.py @@ -0,0 +1,334 @@ +""" + OpenAPI definition + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: v0 + Contact: support@gooddata.com + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from gooddata_api_client.model_utils import ( # noqa: F401 + ApiTypeError, + ModelComposed, + ModelNormal, + ModelSimple, + cached_property, + change_keys_js_to_python, + convert_js_args_to_python_args, + date, + datetime, + file_type, + none_type, + validate_get_composed_info, + OpenApiModel +) +from gooddata_api_client.exceptions import ApiAttributeError + + +def lazy_import(): + from gooddata_api_client.model.assignee_rule import AssigneeRule + from gooddata_api_client.model.attribute_permissions_for_assignee_rule_all_of import AttributePermissionsForAssigneeRuleAllOf + from gooddata_api_client.model.visualization_permissions_assignment import VisualizationPermissionsAssignment + globals()['AssigneeRule'] = AssigneeRule + globals()['AttributePermissionsForAssigneeRuleAllOf'] = AttributePermissionsForAssigneeRuleAllOf + globals()['VisualizationPermissionsAssignment'] = VisualizationPermissionsAssignment + + +class VisualizationPermissionsForAssigneeRule(ModelComposed): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + + Attributes: + allowed_values (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + with a capitalized key describing the allowed value and an allowed + value. These dicts store the allowed enum values. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + discriminator_value_class_map (dict): A dict to go from the discriminator + variable value to the discriminator class name. + validations (dict): The key is the tuple path to the attribute + and the for var_name this is (var_name,). The value is a dict + that stores validations for max_length, min_length, max_items, + min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum, + inclusive_minimum, and regex. + additional_properties_type (tuple): A tuple of classes accepted + as additional properties values. + """ + + allowed_values = { + ('permissions',): { + 'EDIT': "EDIT", + 'SHARE': "SHARE", + 'VIEW': "VIEW", + }, + } + + validations = { + } + + @cached_property + def additional_properties_type(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + """ + lazy_import() + return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501 + + _nullable = False + + @cached_property + def openapi_types(): + """ + This must be a method because a model may have properties that are + of type self, this must run after the class is loaded + + Returns + openapi_types (dict): The key is attribute name + and the value is attribute type. + """ + lazy_import() + return { + 'permissions': ([str],), # noqa: E501 + 'assignee_rule': (AssigneeRule,), # noqa: E501 + } + + @cached_property + def discriminator(): + return None + + + attribute_map = { + 'permissions': 'permissions', # noqa: E501 + 'assignee_rule': 'assigneeRule', # noqa: E501 + } + + read_only_vars = { + } + + @classmethod + @convert_js_args_to_python_args + def _from_openapi_data(cls, *args, **kwargs): # noqa: E501 + """VisualizationPermissionsForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_rule (AssigneeRule): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + self = super(OpenApiModel, cls).__new__(cls) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + + return self + + required_properties = set([ + '_data_store', + '_check_type', + '_spec_property_naming', + '_path_to_item', + '_configuration', + '_visited_composed_classes', + '_composed_instances', + '_var_name_to_model_instances', + '_additional_properties_model_instances', + ]) + + @convert_js_args_to_python_args + def __init__(self, *args, **kwargs): # noqa: E501 + """VisualizationPermissionsForAssigneeRule - a model defined in OpenAPI + + Keyword Args: + permissions ([str]): + assignee_rule (AssigneeRule): + _check_type (bool): if True, values for parameters in openapi_types + will be type checked and a TypeError will be + raised if the wrong type is input. + Defaults to True + _path_to_item (tuple/list): This is a list of keys or values to + drill down to the model in received_data + when deserializing a response + _spec_property_naming (bool): True if the variable names in the input data + are serialized names, as specified in the OpenAPI document. + False if the variable names in the input data + are pythonic names, e.g. snake case (default) + _configuration (Configuration): the instance to use when + deserializing a file_type parameter. + If passed, type conversion is attempted + If omitted no type conversion is done. + _visited_composed_classes (tuple): This stores a tuple of + classes that we have traveled through so that + if we see that class again we will not use its + discriminator again. + When traveling through a discriminator, the + composed schema that is + is traveled through is added to this set. + For example if Animal has a discriminator + petType and we pass in "Dog", and the class Dog + allOf includes Animal, we move through Animal + once using the discriminator, and pick Dog. + Then in Dog, we will make an instance of the + Animal class but this time we won't travel + through its discriminator because we passed in + _visited_composed_classes = (Animal,) + """ + + _check_type = kwargs.pop('_check_type', True) + _spec_property_naming = kwargs.pop('_spec_property_naming', False) + _path_to_item = kwargs.pop('_path_to_item', ()) + _configuration = kwargs.pop('_configuration', None) + _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) + + if args: + for arg in args: + if isinstance(arg, dict): + kwargs.update(arg) + else: + raise ApiTypeError( + "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( + args, + self.__class__.__name__, + ), + path_to_item=_path_to_item, + valid_classes=(self.__class__,), + ) + + self._data_store = {} + self._check_type = _check_type + self._spec_property_naming = _spec_property_naming + self._path_to_item = _path_to_item + self._configuration = _configuration + self._visited_composed_classes = _visited_composed_classes + (self.__class__,) + + constant_args = { + '_check_type': _check_type, + '_path_to_item': _path_to_item, + '_spec_property_naming': _spec_property_naming, + '_configuration': _configuration, + '_visited_composed_classes': self._visited_composed_classes, + } + composed_info = validate_get_composed_info( + constant_args, kwargs, self) + self._composed_instances = composed_info[0] + self._var_name_to_model_instances = composed_info[1] + self._additional_properties_model_instances = composed_info[2] + discarded_args = composed_info[3] + + for var_name, var_value in kwargs.items(): + if var_name in discarded_args and \ + self._configuration is not None and \ + self._configuration.discard_unknown_keys and \ + self._additional_properties_model_instances: + # discard variable. + continue + setattr(self, var_name, var_value) + if var_name in self.read_only_vars: + raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " + f"class with read only attributes.") + + @cached_property + def _composed_schemas(): + # we need this here to make our import statements work + # we must store _composed_schemas in here so the code is only run + # when we invoke this method. If we kept this at the class + # level we would get an error because the class level + # code would be run when this module is imported, and these composed + # classes don't exist yet because their module has not finished + # loading + lazy_import() + return { + 'anyOf': [ + ], + 'allOf': [ + AttributePermissionsForAssigneeRuleAllOf, + VisualizationPermissionsAssignment, + ], + 'oneOf': [ + ], + } diff --git a/gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.py b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.py deleted file mode 100644 index c1d64c60d..000000000 --- a/gooddata-api-client/gooddata_api_client/model/what_if_scenario_config.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.what_if_scenario_item import WhatIfScenarioItem - globals()['WhatIfScenarioItem'] = WhatIfScenarioItem - - -class WhatIfScenarioConfig(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 { - 'include_baseline': (bool,), # noqa: E501 - 'scenarios': ([WhatIfScenarioItem],), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'include_baseline': 'includeBaseline', # noqa: E501 - 'scenarios': 'scenarios', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, include_baseline, scenarios, *args, **kwargs): # noqa: E501 - """WhatIfScenarioConfig - a model defined in OpenAPI - - Args: - include_baseline (bool): Whether baseline (unmodified) values are included - scenarios ([WhatIfScenarioItem]): Scenarios with alternative measure calculations - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.include_baseline = include_baseline - self.scenarios = scenarios - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, include_baseline, scenarios, *args, **kwargs): # noqa: E501 - """WhatIfScenarioConfig - a model defined in OpenAPI - - Args: - include_baseline (bool): Whether baseline (unmodified) values are included - scenarios ([WhatIfScenarioItem]): Scenarios with alternative measure calculations - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.include_baseline = include_baseline - self.scenarios = scenarios - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/what_if_scenario_item.py b/gooddata-api-client/gooddata_api_client/model/what_if_scenario_item.py deleted file mode 100644 index 41160fcfa..000000000 --- a/gooddata-api-client/gooddata_api_client/model/what_if_scenario_item.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - -def lazy_import(): - from gooddata_api_client.model.what_if_measure_adjustment_config import WhatIfMeasureAdjustmentConfig - globals()['WhatIfMeasureAdjustmentConfig'] = WhatIfMeasureAdjustmentConfig - - -class WhatIfScenarioItem(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 { - 'adjustments': ([WhatIfMeasureAdjustmentConfig],), # noqa: E501 - 'label': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'adjustments': 'adjustments', # noqa: E501 - 'label': 'label', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, adjustments, label, *args, **kwargs): # noqa: E501 - """WhatIfScenarioItem - a model defined in OpenAPI - - Args: - adjustments ([WhatIfMeasureAdjustmentConfig]): Measure adjustments for this scenario - label (str): Human-readable scenario label - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.adjustments = adjustments - self.label = label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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, adjustments, label, *args, **kwargs): # noqa: E501 - """WhatIfScenarioItem - a model defined in OpenAPI - - Args: - adjustments ([WhatIfMeasureAdjustmentConfig]): Measure adjustments for this scenario - label (str): Human-readable scenario label - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make 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.adjustments = adjustments - self.label = label - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/workflow_dashboard_summary_request_dto.py b/gooddata-api-client/gooddata_api_client/model/workflow_dashboard_summary_request_dto.py deleted file mode 100644 index eb643f277..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workflow_dashboard_summary_request_dto.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkflowDashboardSummaryRequestDto(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 { - 'dashboard_id': (str,), # noqa: E501 - 'custom_user_prompt': (str,), # noqa: E501 - 'key_metric_ids': ([str],), # noqa: E501 - 'reference_quarter': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'dashboard_id': 'dashboardId', # noqa: E501 - 'custom_user_prompt': 'customUserPrompt', # noqa: E501 - 'key_metric_ids': 'keyMetricIds', # noqa: E501 - 'reference_quarter': 'referenceQuarter', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, dashboard_id, *args, **kwargs): # noqa: E501 - """WorkflowDashboardSummaryRequestDto - a model defined in OpenAPI - - Args: - dashboard_id (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,) - custom_user_prompt (str): [optional] # noqa: E501 - key_metric_ids ([str]): [optional] # noqa: E501 - reference_quarter (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.dashboard_id = dashboard_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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_id, *args, **kwargs): # noqa: E501 - """WorkflowDashboardSummaryRequestDto - a model defined in OpenAPI - - Args: - dashboard_id (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,) - custom_user_prompt (str): [optional] # noqa: E501 - key_metric_ids ([str]): [optional] # noqa: E501 - reference_quarter (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.dashboard_id = dashboard_id - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is 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/workflow_dashboard_summary_response_dto.py b/gooddata-api-client/gooddata_api_client/model/workflow_dashboard_summary_response_dto.py deleted file mode 100644 index 5229d4594..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workflow_dashboard_summary_response_dto.py +++ /dev/null @@ -1,282 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkflowDashboardSummaryResponseDto(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 { - 'message': (str,), # noqa: E501 - 'run_id': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'message': 'message', # noqa: E501 - 'run_id': 'runId', # noqa: E501 - 'status': 'status', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, message, run_id, status, *args, **kwargs): # noqa: E501 - """WorkflowDashboardSummaryResponseDto - a model defined in OpenAPI - - Args: - message (str): - run_id (str): - status (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.run_id = run_id - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, message, run_id, status, *args, **kwargs): # noqa: E501 - """WorkflowDashboardSummaryResponseDto - a model defined in OpenAPI - - Args: - message (str): - run_id (str): - status (str): - - Keyword Args: - _check_type (bool): if True, values for parameters in openapi_types - will be type checked and a TypeError will be - raised if the wrong type is input. - Defaults to True - _path_to_item (tuple/list): This is a list of keys or values to - drill down to the model in received_data - when deserializing a response - _spec_property_naming (bool): True if the variable names in the input data - are serialized names, as specified in the OpenAPI document. - False if the variable names in the input data - are pythonic names, e.g. snake case (default) - _configuration (Configuration): the instance to use when - deserializing a file_type parameter. - If passed, type conversion is attempted - If omitted no type conversion is done. - _visited_composed_classes (tuple): This stores a tuple of - classes that we have traveled through so that - if we see that class again we will not use its - discriminator again. - When traveling through a discriminator, the - composed schema that is - is traveled through is added to this set. - For example if Animal has a discriminator - petType and we pass in "Dog", and the class Dog - allOf includes Animal, we move through Animal - once using the discriminator, and pick Dog. - Then in Dog, we will make an instance of the - Animal class but this time we won't travel - through its discriminator because we passed in - _visited_composed_classes = (Animal,) - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.run_id = run_id - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workflow_status_response_dto.py b/gooddata-api-client/gooddata_api_client/model/workflow_status_response_dto.py deleted file mode 100644 index 430622df2..000000000 --- a/gooddata-api-client/gooddata_api_client/model/workflow_status_response_dto.py +++ /dev/null @@ -1,294 +0,0 @@ -""" - OpenAPI definition - - No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 - - The version of the OpenAPI document: v0 - Contact: support@gooddata.com - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from gooddata_api_client.model_utils import ( # noqa: F401 - ApiTypeError, - ModelComposed, - ModelNormal, - ModelSimple, - cached_property, - change_keys_js_to_python, - convert_js_args_to_python_args, - date, - datetime, - file_type, - none_type, - validate_get_composed_info, - OpenApiModel -) -from gooddata_api_client.exceptions import ApiAttributeError - - - -class WorkflowStatusResponseDto(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 { - 'message': (str,), # noqa: E501 - 'run_id': (str,), # noqa: E501 - 'status': (str,), # noqa: E501 - 'current_phase': (str,), # noqa: E501 - 'error': (str,), # noqa: E501 - 'result': ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)},), # noqa: E501 - } - - @cached_property - def discriminator(): - return None - - - attribute_map = { - 'message': 'message', # noqa: E501 - 'run_id': 'runId', # noqa: E501 - 'status': 'status', # noqa: E501 - 'current_phase': 'currentPhase', # noqa: E501 - 'error': 'error', # noqa: E501 - 'result': 'result', # noqa: E501 - } - - read_only_vars = { - } - - _composed_schemas = {} - - @classmethod - @convert_js_args_to_python_args - def _from_openapi_data(cls, message, run_id, status, *args, **kwargs): # noqa: E501 - """WorkflowStatusResponseDto - a model defined in OpenAPI - - Args: - message (str): - run_id (str): - status (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,) - current_phase (str): [optional] # noqa: E501 - error (str): [optional] # noqa: E501 - result ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', True) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - self = super(OpenApiModel, cls).__new__(cls) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.run_id = run_id - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - return self - - required_properties = set([ - '_data_store', - '_check_type', - '_spec_property_naming', - '_path_to_item', - '_configuration', - '_visited_composed_classes', - ]) - - @convert_js_args_to_python_args - def __init__(self, message, run_id, status, *args, **kwargs): # noqa: E501 - """WorkflowStatusResponseDto - a model defined in OpenAPI - - Args: - message (str): - run_id (str): - status (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,) - current_phase (str): [optional] # noqa: E501 - error (str): [optional] # noqa: E501 - result ({str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}): [optional] # noqa: E501 - """ - - _check_type = kwargs.pop('_check_type', True) - _spec_property_naming = kwargs.pop('_spec_property_naming', False) - _path_to_item = kwargs.pop('_path_to_item', ()) - _configuration = kwargs.pop('_configuration', None) - _visited_composed_classes = kwargs.pop('_visited_composed_classes', ()) - - if args: - for arg in args: - if isinstance(arg, dict): - kwargs.update(arg) - else: - raise ApiTypeError( - "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % ( - args, - self.__class__.__name__, - ), - path_to_item=_path_to_item, - valid_classes=(self.__class__,), - ) - - self._data_store = {} - self._check_type = _check_type - self._spec_property_naming = _spec_property_naming - self._path_to_item = _path_to_item - self._configuration = _configuration - self._visited_composed_classes = _visited_composed_classes + (self.__class__,) - - self.message = message - self.run_id = run_id - self.status = status - for var_name, var_value in kwargs.items(): - if var_name not in self.attribute_map and \ - self._configuration is not None and \ - self._configuration.discard_unknown_keys and \ - self.additional_properties_type is None: - # discard variable. - continue - setattr(self, var_name, var_value) - if var_name in self.read_only_vars: - raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate " - f"class with read only attributes.") diff --git a/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py b/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py index 149031040..1fcec692a 100644 --- a/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py +++ b/gooddata-api-client/gooddata_api_client/model/workspace_permission_assignment.py @@ -72,6 +72,7 @@ class WorkspacePermissionAssignment(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", @@ -88,6 +89,7 @@ class WorkspacePermissionAssignment(ModelNormal): 'READ_KNOWLEDGE_DOCUMENTS': "READ_KNOWLEDGE_DOCUMENTS", 'CREATE_FILTER_VIEW': "CREATE_FILTER_VIEW", 'CREATE_METRIC': "CREATE_METRIC", + 'MANAGE_VISUALIZATIONS': "MANAGE_VISUALIZATIONS", 'CREATE_VISUALIZATION': "CREATE_VISUALIZATION", 'CREATE_COMPUTED_ATTRIBUTE': "CREATE_COMPUTED_ATTRIBUTE", 'VIEW': "VIEW", diff --git a/gooddata-api-client/gooddata_api_client/models/__init__.py b/gooddata-api-client/gooddata_api_client/models/__init__.py index ef80a4c8e..a5118bc89 100644 --- a/gooddata-api-client/gooddata_api_client/models/__init__.py +++ b/gooddata-api-client/gooddata_api_client/models/__init__.py @@ -15,13 +15,14 @@ from gooddata_api_client.model.absolute_granularity_date_filter import AbsoluteGranularityDateFilter from gooddata_api_client.model.absolute_granularity_date_filter_absolute_granularity_date_filter import AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter from gooddata_api_client.model.abstract_measure_value_filter import AbstractMeasureValueFilter -from gooddata_api_client.model.active_object_identification import ActiveObjectIdentification from gooddata_api_client.model.ad_hoc_automation import AdHocAutomation from gooddata_api_client.model.add_database_data_source_request import AddDatabaseDataSourceRequest from gooddata_api_client.model.add_database_data_source_response import AddDatabaseDataSourceResponse from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens from gooddata_api_client.model.afm_execution import AfmExecution from gooddata_api_client.model.afm_execution_response import AfmExecutionResponse +from gooddata_api_client.model.afm_flow_input import AfmFlowInput +from gooddata_api_client.model.afm_flow_input_all_of import AfmFlowInputAllOf from gooddata_api_client.model.afm_identifier import AfmIdentifier from gooddata_api_client.model.afm_local_identifier import AfmLocalIdentifier from gooddata_api_client.model.afm_object_identifier import AfmObjectIdentifier @@ -40,8 +41,6 @@ from gooddata_api_client.model.afm_valid_descendants_response import AfmValidDescendantsResponse from gooddata_api_client.model.afm_valid_objects_query import AfmValidObjectsQuery from gooddata_api_client.model.afm_valid_objects_response import AfmValidObjectsResponse -from gooddata_api_client.model.aggregate_key_config import AggregateKeyConfig -from gooddata_api_client.model.ai_usage_metadata_item import AiUsageMetadataItem from gooddata_api_client.model.alert_afm import AlertAfm from gooddata_api_client.model.alert_condition import AlertCondition from gooddata_api_client.model.alert_condition_operand import AlertConditionOperand @@ -49,7 +48,6 @@ from gooddata_api_client.model.alert_evaluation_row import AlertEvaluationRow from gooddata_api_client.model.all_time_date_filter import AllTimeDateFilter from gooddata_api_client.model.all_time_date_filter_all_time_date_filter import AllTimeDateFilterAllTimeDateFilter -from gooddata_api_client.model.allowed_relationship_type import AllowedRelationshipType from gooddata_api_client.model.amplitude_service import AmplitudeService from gooddata_api_client.model.analytics_catalog_created_by import AnalyticsCatalogCreatedBy from gooddata_api_client.model.analytics_catalog_tags import AnalyticsCatalogTags @@ -62,7 +60,6 @@ from gooddata_api_client.model.analyze_csv_response_config import AnalyzeCsvResponseConfig 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_config import AnomalyDetectionConfig 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.anomaly_detection_wrapper import AnomalyDetectionWrapper @@ -88,16 +85,12 @@ from gooddata_api_client.model.attribute_header import AttributeHeader from gooddata_api_client.model.attribute_header_attribute_header import AttributeHeaderAttributeHeader from gooddata_api_client.model.attribute_item import AttributeItem -from gooddata_api_client.model.attribute_negative_filter import AttributeNegativeFilter -from gooddata_api_client.model.attribute_negative_filter_all_of import AttributeNegativeFilterAllOf from gooddata_api_client.model.attribute_permissions import AttributePermissions from gooddata_api_client.model.attribute_permissions_assignment import AttributePermissionsAssignment from gooddata_api_client.model.attribute_permissions_for_assignee import AttributePermissionsForAssignee from gooddata_api_client.model.attribute_permissions_for_assignee_all_of import AttributePermissionsForAssigneeAllOf from gooddata_api_client.model.attribute_permissions_for_assignee_rule import AttributePermissionsForAssigneeRule from gooddata_api_client.model.attribute_permissions_for_assignee_rule_all_of import AttributePermissionsForAssigneeRuleAllOf -from gooddata_api_client.model.attribute_positive_filter import AttributePositiveFilter -from gooddata_api_client.model.attribute_positive_filter_all_of import AttributePositiveFilterAllOf from gooddata_api_client.model.attribute_result_header import AttributeResultHeader from gooddata_api_client.model.automation_alert import AutomationAlert from gooddata_api_client.model.automation_dashboard_tabular_export import AutomationDashboardTabularExport @@ -128,25 +121,13 @@ from gooddata_api_client.model.calendar_definition import CalendarDefinition from gooddata_api_client.model.calendar_granularity import CalendarGranularity from gooddata_api_client.model.calendar_table_reference import CalendarTableReference -from gooddata_api_client.model.certification_info import CertificationInfo -from gooddata_api_client.model.change_analysis_params import ChangeAnalysisParams from gooddata_api_client.model.change_analysis_request import ChangeAnalysisRequest from gooddata_api_client.model.change_analysis_response import ChangeAnalysisResponse from gooddata_api_client.model.change_analysis_result import ChangeAnalysisResult -from gooddata_api_client.model.chat_history_interaction import ChatHistoryInteraction -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.chat_usage_response import ChatUsageResponse -from gooddata_api_client.model.clustering_config import ClusteringConfig from gooddata_api_client.model.clustering_request import ClusteringRequest from gooddata_api_client.model.clustering_result import ClusteringResult -from gooddata_api_client.model.column_expression import ColumnExpression -from gooddata_api_client.model.column_info import ColumnInfo from gooddata_api_client.model.column_location import ColumnLocation from gooddata_api_client.model.column_override import ColumnOverride -from gooddata_api_client.model.column_partition_config import ColumnPartitionConfig from gooddata_api_client.model.column_statistic import ColumnStatistic from gooddata_api_client.model.column_statistic_warning import ColumnStatisticWarning from gooddata_api_client.model.column_statistics_entry import ColumnStatisticsEntry @@ -162,17 +143,35 @@ from gooddata_api_client.model.comparison_wrapper import ComparisonWrapper from gooddata_api_client.model.compound_measure_value_filter import CompoundMeasureValueFilter from gooddata_api_client.model.compound_measure_value_filter_compound_measure_value_filter import CompoundMeasureValueFilterCompoundMeasureValueFilter +from gooddata_api_client.model.computed_attribute_permissions import ComputedAttributePermissions +from gooddata_api_client.model.computed_attribute_permissions_assignment import ComputedAttributePermissionsAssignment +from gooddata_api_client.model.computed_attribute_permissions_for_assignee import ComputedAttributePermissionsForAssignee +from gooddata_api_client.model.computed_attribute_permissions_for_assignee_rule import ComputedAttributePermissionsForAssigneeRule +from gooddata_api_client.model.conditional_formatting import ConditionalFormatting +from gooddata_api_client.model.conditional_formatting_absolute_date_value import ConditionalFormattingAbsoluteDateValue +from gooddata_api_client.model.conditional_formatting_absolute_date_value_all_of import ConditionalFormattingAbsoluteDateValueAllOf +from gooddata_api_client.model.conditional_formatting_attribute_target import ConditionalFormattingAttributeTarget +from gooddata_api_client.model.conditional_formatting_attribute_target_all_of import ConditionalFormattingAttributeTargetAllOf +from gooddata_api_client.model.conditional_formatting_condition import ConditionalFormattingCondition +from gooddata_api_client.model.conditional_formatting_format import ConditionalFormattingFormat +from gooddata_api_client.model.conditional_formatting_literal import ConditionalFormattingLiteral +from gooddata_api_client.model.conditional_formatting_literal_range_value import ConditionalFormattingLiteralRangeValue +from gooddata_api_client.model.conditional_formatting_literal_range_value_all_of import ConditionalFormattingLiteralRangeValueAllOf +from gooddata_api_client.model.conditional_formatting_literal_value import ConditionalFormattingLiteralValue +from gooddata_api_client.model.conditional_formatting_literal_value_all_of import ConditionalFormattingLiteralValueAllOf +from gooddata_api_client.model.conditional_formatting_measure_target import ConditionalFormattingMeasureTarget +from gooddata_api_client.model.conditional_formatting_measure_target_all_of import ConditionalFormattingMeasureTargetAllOf +from gooddata_api_client.model.conditional_formatting_none_value import ConditionalFormattingNoneValue +from gooddata_api_client.model.conditional_formatting_none_value_all_of import ConditionalFormattingNoneValueAllOf +from gooddata_api_client.model.conditional_formatting_relative_date_value import ConditionalFormattingRelativeDateValue +from gooddata_api_client.model.conditional_formatting_relative_date_value_all_of import ConditionalFormattingRelativeDateValueAllOf +from gooddata_api_client.model.conditional_formatting_rule import ConditionalFormattingRule +from gooddata_api_client.model.conditional_formatting_target import ConditionalFormattingTarget +from gooddata_api_client.model.conditional_formatting_value import ConditionalFormattingValue from gooddata_api_client.model.content_slide_template import ContentSlideTemplate from gooddata_api_client.model.convert_geo_file_request import ConvertGeoFileRequest from gooddata_api_client.model.convert_geo_file_response import ConvertGeoFileResponse from gooddata_api_client.model.cover_slide_template import CoverSlideTemplate -from gooddata_api_client.model.create_pipe_table_request import CreatePipeTableRequest -from gooddata_api_client.model.create_pipe_table_request_distribution_config import CreatePipeTableRequestDistributionConfig -from gooddata_api_client.model.create_pipe_table_request_key_config import CreatePipeTableRequestKeyConfig -from gooddata_api_client.model.create_pipe_table_request_partition_config import CreatePipeTableRequestPartitionConfig -from gooddata_api_client.model.created_visualization import CreatedVisualization -from gooddata_api_client.model.created_visualization_filters_inner import CreatedVisualizationFiltersInner -from gooddata_api_client.model.created_visualizations import CreatedVisualizations from gooddata_api_client.model.csv_convert_options import CsvConvertOptions from gooddata_api_client.model.csv_convert_options_column_type import CsvConvertOptionsColumnType from gooddata_api_client.model.csv_manifest_body import CsvManifestBody @@ -192,7 +191,6 @@ from gooddata_api_client.model.dashboard_compound_condition_item import DashboardCompoundConditionItem from gooddata_api_client.model.dashboard_compound_range_condition import DashboardCompoundRangeCondition from gooddata_api_client.model.dashboard_compound_range_condition_range import DashboardCompoundRangeConditionRange -from gooddata_api_client.model.dashboard_context import DashboardContext from gooddata_api_client.model.dashboard_date_filter import DashboardDateFilter from gooddata_api_client.model.dashboard_date_filter_date_filter import DashboardDateFilterDateFilter from gooddata_api_client.model.dashboard_date_filter_date_filter_from import DashboardDateFilterDateFilterFrom @@ -220,12 +218,7 @@ from gooddata_api_client.model.dataset_grain import DatasetGrain from gooddata_api_client.model.dataset_reference_identifier import DatasetReferenceIdentifier from gooddata_api_client.model.dataset_workspace_data_filter_identifier import DatasetWorkspaceDataFilterIdentifier -from gooddata_api_client.model.date_absolute_filter import DateAbsoluteFilter -from gooddata_api_client.model.date_absolute_filter_all_of import DateAbsoluteFilterAllOf from gooddata_api_client.model.date_filter import DateFilter -from gooddata_api_client.model.date_relative_filter import DateRelativeFilter -from gooddata_api_client.model.date_relative_filter_all_of import DateRelativeFilterAllOf -from gooddata_api_client.model.date_trunc_partition_config import DateTruncPartitionConfig from gooddata_api_client.model.date_value import DateValue from gooddata_api_client.model.declarative_agent import DeclarativeAgent from gooddata_api_client.model.declarative_agents import DeclarativeAgents @@ -246,6 +239,8 @@ from gooddata_api_client.model.declarative_calendar import DeclarativeCalendar from gooddata_api_client.model.declarative_color_palette import DeclarativeColorPalette from gooddata_api_client.model.declarative_column import DeclarativeColumn +from gooddata_api_client.model.declarative_computed_attribute import DeclarativeComputedAttribute +from gooddata_api_client.model.declarative_computed_attribute_content import DeclarativeComputedAttributeContent from gooddata_api_client.model.declarative_csp_directive import DeclarativeCspDirective from gooddata_api_client.model.declarative_custom_application_setting import DeclarativeCustomApplicationSetting from gooddata_api_client.model.declarative_custom_geo_collection import DeclarativeCustomGeoCollection @@ -286,6 +281,9 @@ from gooddata_api_client.model.declarative_parameter import DeclarativeParameter 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 +from gooddata_api_client.model.declarative_report_page_layout import DeclarativeReportPageLayout +from gooddata_api_client.model.declarative_report_template import DeclarativeReportTemplate from gooddata_api_client.model.declarative_rsa_specification import DeclarativeRsaSpecification from gooddata_api_client.model.declarative_setting import DeclarativeSetting from gooddata_api_client.model.declarative_single_workspace_permission import DeclarativeSingleWorkspacePermission @@ -334,11 +332,8 @@ from gooddata_api_client.model.depends_on_item import DependsOnItem from gooddata_api_client.model.depends_on_match_filter import DependsOnMatchFilter from gooddata_api_client.model.depends_on_match_filter_all_of import DependsOnMatchFilterAllOf -from gooddata_api_client.model.dim_attribute import DimAttribute from gooddata_api_client.model.dimension import Dimension from gooddata_api_client.model.dimension_header import DimensionHeader -from gooddata_api_client.model.distribution_config import DistributionConfig -from gooddata_api_client.model.duplicate_key_config import DuplicateKeyConfig from gooddata_api_client.model.element import Element from gooddata_api_client.model.elements_request import ElementsRequest from gooddata_api_client.model.elements_request_depends_on_inner import ElementsRequestDependsOnInner @@ -348,7 +343,6 @@ from gooddata_api_client.model.entity_search_body import EntitySearchBody from gooddata_api_client.model.entity_search_page import EntitySearchPage from gooddata_api_client.model.entity_search_sort import EntitySearchSort -from gooddata_api_client.model.error_info import ErrorInfo from gooddata_api_client.model.execution_links import ExecutionLinks from gooddata_api_client.model.execution_response import ExecutionResponse from gooddata_api_client.model.execution_result import ExecutionResult @@ -371,22 +365,31 @@ from gooddata_api_client.model.feature_flags_context import FeatureFlagsContext from gooddata_api_client.model.features import Features from gooddata_api_client.model.file import File -from gooddata_api_client.model.filter import Filter +from gooddata_api_client.model.file_flow_input import FileFlowInput +from gooddata_api_client.model.file_flow_input_all_of import FileFlowInputAllOf from gooddata_api_client.model.filter_by import FilterBy from gooddata_api_client.model.filter_definition import FilterDefinition from gooddata_api_client.model.filter_definition_for_simple_measure import FilterDefinitionForSimpleMeasure from gooddata_api_client.model.fiscal_year_calendar_definition import FiscalYearCalendarDefinition from gooddata_api_client.model.fiscal_year_calendar_definition_all_of import FiscalYearCalendarDefinitionAllOf -from gooddata_api_client.model.forecast_config import ForecastConfig +from gooddata_api_client.model.flow_column import FlowColumn +from gooddata_api_client.model.flow_execution_response import FlowExecutionResponse +from gooddata_api_client.model.flow_input import FlowInput +from gooddata_api_client.model.flow_operation_descriptor import FlowOperationDescriptor +from gooddata_api_client.model.flow_operation_input import FlowOperationInput +from gooddata_api_client.model.flow_operation_output import FlowOperationOutput +from gooddata_api_client.model.flow_operations import FlowOperations +from gooddata_api_client.model.flow_request import FlowRequest +from gooddata_api_client.model.flow_result_metadata import FlowResultMetadata +from gooddata_api_client.model.flow_table_paging import FlowTablePaging +from gooddata_api_client.model.flow_table_result import FlowTableResult +from gooddata_api_client.model.flow_transformation import FlowTransformation from gooddata_api_client.model.forecast_request import ForecastRequest from gooddata_api_client.model.forecast_result import ForecastResult -from gooddata_api_client.model.found_objects import FoundObjects from gooddata_api_client.model.frequency import Frequency from gooddata_api_client.model.frequency_bucket import FrequencyBucket from gooddata_api_client.model.frequency_properties import FrequencyProperties from gooddata_api_client.model.gd_storage_file import GdStorageFile -from gooddata_api_client.model.gen_ai_ranking_filter import GenAiRankingFilter -from gooddata_api_client.model.gen_ai_ranking_filter_all_of import GenAiRankingFilterAllOf from gooddata_api_client.model.generate_description_request import GenerateDescriptionRequest from gooddata_api_client.model.generate_description_response import GenerateDescriptionResponse from gooddata_api_client.model.generate_ldm_request import GenerateLdmRequest @@ -404,7 +407,6 @@ from gooddata_api_client.model.grain_identifier import GrainIdentifier from gooddata_api_client.model.granted_permission import GrantedPermission from gooddata_api_client.model.granularities_formatting import GranularitiesFormatting -from gooddata_api_client.model.hash_distribution_config import HashDistributionConfig from gooddata_api_client.model.header_group import HeaderGroup from gooddata_api_client.model.hierarchy_object_identification import HierarchyObjectIdentification from gooddata_api_client.model.histogram import Histogram @@ -428,17 +430,20 @@ from gooddata_api_client.model.inline_filter_definition_inline import InlineFilterDefinitionInline from gooddata_api_client.model.inline_measure_definition import InlineMeasureDefinition from gooddata_api_client.model.inline_measure_definition_inline import InlineMeasureDefinitionInline -from gooddata_api_client.model.insight_widget_descriptor import InsightWidgetDescriptor +from gooddata_api_client.model.instruction import Instruction from gooddata_api_client.model.intro_slide_template import IntroSlideTemplate +from gooddata_api_client.model.invitation import Invitation from gooddata_api_client.model.ip_allowlist_policy_targets import IpAllowlistPolicyTargets from gooddata_api_client.model.json_api_agent_in import JsonApiAgentIn from gooddata_api_client.model.json_api_agent_in_attributes import JsonApiAgentInAttributes +from gooddata_api_client.model.json_api_agent_in_attributes_instructions_inner import JsonApiAgentInAttributesInstructionsInner from gooddata_api_client.model.json_api_agent_in_document import JsonApiAgentInDocument from gooddata_api_client.model.json_api_agent_in_relationships import JsonApiAgentInRelationships from gooddata_api_client.model.json_api_agent_in_relationships_user_groups import JsonApiAgentInRelationshipsUserGroups from gooddata_api_client.model.json_api_agent_out import JsonApiAgentOut from gooddata_api_client.model.json_api_agent_out_attributes import JsonApiAgentOutAttributes from gooddata_api_client.model.json_api_agent_out_document import JsonApiAgentOutDocument +from gooddata_api_client.model.json_api_agent_out_document_meta import JsonApiAgentOutDocumentMeta from gooddata_api_client.model.json_api_agent_out_includes import JsonApiAgentOutIncludes from gooddata_api_client.model.json_api_agent_out_list import JsonApiAgentOutList from gooddata_api_client.model.json_api_agent_out_list_meta import JsonApiAgentOutListMeta @@ -474,6 +479,7 @@ from gooddata_api_client.model.json_api_analytical_dashboard_out_meta_access_info import JsonApiAnalyticalDashboardOutMetaAccessInfo from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships import JsonApiAnalyticalDashboardOutRelationships from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_analytical_dashboards import JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards +from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_computed_attributes import JsonApiAnalyticalDashboardOutRelationshipsComputedAttributes from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_dashboard_plugins import JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_datasets import JsonApiAnalyticalDashboardOutRelationshipsDatasets from gooddata_api_client.model.json_api_analytical_dashboard_out_relationships_filter_contexts import JsonApiAnalyticalDashboardOutRelationshipsFilterContexts @@ -495,6 +501,7 @@ from gooddata_api_client.model.json_api_api_token_out_attributes import JsonApiApiTokenOutAttributes from gooddata_api_client.model.json_api_api_token_out_document import JsonApiApiTokenOutDocument from gooddata_api_client.model.json_api_api_token_out_list import JsonApiApiTokenOutList +from gooddata_api_client.model.json_api_api_token_out_list_meta import JsonApiApiTokenOutListMeta from gooddata_api_client.model.json_api_api_token_out_with_links import JsonApiApiTokenOutWithLinks from gooddata_api_client.model.json_api_attribute_hierarchy_in import JsonApiAttributeHierarchyIn from gooddata_api_client.model.json_api_attribute_hierarchy_in_attributes import JsonApiAttributeHierarchyInAttributes @@ -514,9 +521,11 @@ from gooddata_api_client.model.json_api_attribute_linkage import JsonApiAttributeLinkage from gooddata_api_client.model.json_api_attribute_out import JsonApiAttributeOut from gooddata_api_client.model.json_api_attribute_out_attributes import JsonApiAttributeOutAttributes +from gooddata_api_client.model.json_api_attribute_out_attributes_conditional_formatting import JsonApiAttributeOutAttributesConditionalFormatting from gooddata_api_client.model.json_api_attribute_out_document import JsonApiAttributeOutDocument from gooddata_api_client.model.json_api_attribute_out_includes import JsonApiAttributeOutIncludes from gooddata_api_client.model.json_api_attribute_out_list import JsonApiAttributeOutList +from gooddata_api_client.model.json_api_attribute_out_meta import JsonApiAttributeOutMeta from gooddata_api_client.model.json_api_attribute_out_relationships import JsonApiAttributeOutRelationships from gooddata_api_client.model.json_api_attribute_out_relationships_attribute_hierarchies import JsonApiAttributeOutRelationshipsAttributeHierarchies from gooddata_api_client.model.json_api_attribute_out_relationships_default_view import JsonApiAttributeOutRelationshipsDefaultView @@ -553,6 +562,7 @@ from gooddata_api_client.model.json_api_automation_out_list import JsonApiAutomationOutList from gooddata_api_client.model.json_api_automation_out_relationships import JsonApiAutomationOutRelationships from gooddata_api_client.model.json_api_automation_out_relationships_automation_results import JsonApiAutomationOutRelationshipsAutomationResults +from gooddata_api_client.model.json_api_automation_out_relationships_facts import JsonApiAutomationOutRelationshipsFacts from gooddata_api_client.model.json_api_automation_out_with_links import JsonApiAutomationOutWithLinks from gooddata_api_client.model.json_api_automation_patch import JsonApiAutomationPatch from gooddata_api_client.model.json_api_automation_patch_document import JsonApiAutomationPatchDocument @@ -575,6 +585,24 @@ from gooddata_api_client.model.json_api_color_palette_patch import JsonApiColorPalettePatch from gooddata_api_client.model.json_api_color_palette_patch_attributes import JsonApiColorPalettePatchAttributes from gooddata_api_client.model.json_api_color_palette_patch_document import JsonApiColorPalettePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_in import JsonApiComputedAttributeIn +from gooddata_api_client.model.json_api_computed_attribute_in_attributes import JsonApiComputedAttributeInAttributes +from gooddata_api_client.model.json_api_computed_attribute_in_attributes_content import JsonApiComputedAttributeInAttributesContent +from gooddata_api_client.model.json_api_computed_attribute_in_document import JsonApiComputedAttributeInDocument +from gooddata_api_client.model.json_api_computed_attribute_linkage import JsonApiComputedAttributeLinkage +from gooddata_api_client.model.json_api_computed_attribute_out import JsonApiComputedAttributeOut +from gooddata_api_client.model.json_api_computed_attribute_out_attributes import JsonApiComputedAttributeOutAttributes +from gooddata_api_client.model.json_api_computed_attribute_out_document import JsonApiComputedAttributeOutDocument +from gooddata_api_client.model.json_api_computed_attribute_out_includes import JsonApiComputedAttributeOutIncludes +from gooddata_api_client.model.json_api_computed_attribute_out_list import JsonApiComputedAttributeOutList +from gooddata_api_client.model.json_api_computed_attribute_out_relationships import JsonApiComputedAttributeOutRelationships +from gooddata_api_client.model.json_api_computed_attribute_out_with_links import JsonApiComputedAttributeOutWithLinks +from gooddata_api_client.model.json_api_computed_attribute_patch import JsonApiComputedAttributePatch +from gooddata_api_client.model.json_api_computed_attribute_patch_attributes import JsonApiComputedAttributePatchAttributes +from gooddata_api_client.model.json_api_computed_attribute_patch_document import JsonApiComputedAttributePatchDocument +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id import JsonApiComputedAttributePostOptionalId +from gooddata_api_client.model.json_api_computed_attribute_post_optional_id_document import JsonApiComputedAttributePostOptionalIdDocument +from gooddata_api_client.model.json_api_computed_attribute_to_many_linkage import JsonApiComputedAttributeToManyLinkage from gooddata_api_client.model.json_api_cookie_security_configuration_in import JsonApiCookieSecurityConfigurationIn from gooddata_api_client.model.json_api_cookie_security_configuration_in_attributes import JsonApiCookieSecurityConfigurationInAttributes from gooddata_api_client.model.json_api_cookie_security_configuration_in_document import JsonApiCookieSecurityConfigurationInDocument @@ -669,15 +697,14 @@ from gooddata_api_client.model.json_api_dataset_out_list import JsonApiDatasetOutList from gooddata_api_client.model.json_api_dataset_out_relationships import JsonApiDatasetOutRelationships from gooddata_api_client.model.json_api_dataset_out_relationships_aggregated_facts import JsonApiDatasetOutRelationshipsAggregatedFacts -from gooddata_api_client.model.json_api_dataset_out_relationships_facts import JsonApiDatasetOutRelationshipsFacts from gooddata_api_client.model.json_api_dataset_out_relationships_workspace_data_filters import JsonApiDatasetOutRelationshipsWorkspaceDataFilters from gooddata_api_client.model.json_api_dataset_out_with_links import JsonApiDatasetOutWithLinks from gooddata_api_client.model.json_api_dataset_patch import JsonApiDatasetPatch +from gooddata_api_client.model.json_api_dataset_patch_attributes import JsonApiDatasetPatchAttributes from gooddata_api_client.model.json_api_dataset_patch_document import JsonApiDatasetPatchDocument from gooddata_api_client.model.json_api_dataset_to_many_linkage import JsonApiDatasetToManyLinkage from gooddata_api_client.model.json_api_dataset_to_one_linkage import JsonApiDatasetToOneLinkage from gooddata_api_client.model.json_api_document_database_instance import JsonApiDocumentDatabaseInstance -from gooddata_api_client.model.json_api_document_pipe_table import JsonApiDocumentPipeTable from gooddata_api_client.model.json_api_entitlement_out import JsonApiEntitlementOut from gooddata_api_client.model.json_api_entitlement_out_attributes import JsonApiEntitlementOutAttributes from gooddata_api_client.model.json_api_entitlement_out_document import JsonApiEntitlementOutDocument @@ -787,8 +814,6 @@ from gooddata_api_client.model.json_api_item_data_source_info import JsonApiItemDataSourceInfo from gooddata_api_client.model.json_api_item_database_instance import JsonApiItemDatabaseInstance from gooddata_api_client.model.json_api_item_object_storage_info import JsonApiItemObjectStorageInfo -from gooddata_api_client.model.json_api_item_pipe_table import JsonApiItemPipeTable -from gooddata_api_client.model.json_api_item_pipe_table_summary import JsonApiItemPipeTableSummary from gooddata_api_client.model.json_api_item_service_info import JsonApiItemServiceInfo from gooddata_api_client.model.json_api_jwk_in import JsonApiJwkIn from gooddata_api_client.model.json_api_jwk_in_attributes import JsonApiJwkInAttributes @@ -820,6 +845,7 @@ from gooddata_api_client.model.json_api_label_linkage import JsonApiLabelLinkage from gooddata_api_client.model.json_api_label_out import JsonApiLabelOut from gooddata_api_client.model.json_api_label_out_attributes import JsonApiLabelOutAttributes +from gooddata_api_client.model.json_api_label_out_attributes_conditional_formatting import JsonApiLabelOutAttributesConditionalFormatting from gooddata_api_client.model.json_api_label_out_attributes_geo_area_config import JsonApiLabelOutAttributesGeoAreaConfig from gooddata_api_client.model.json_api_label_out_attributes_translations_inner import JsonApiLabelOutAttributesTranslationsInner from gooddata_api_client.model.json_api_label_out_document import JsonApiLabelOutDocument @@ -827,13 +853,13 @@ from gooddata_api_client.model.json_api_label_out_relationships import JsonApiLabelOutRelationships from gooddata_api_client.model.json_api_label_out_with_links import JsonApiLabelOutWithLinks from gooddata_api_client.model.json_api_label_patch import JsonApiLabelPatch +from gooddata_api_client.model.json_api_label_patch_attributes import JsonApiLabelPatchAttributes from gooddata_api_client.model.json_api_label_patch_document import JsonApiLabelPatchDocument from gooddata_api_client.model.json_api_label_to_many_linkage import JsonApiLabelToManyLinkage from gooddata_api_client.model.json_api_label_to_one_linkage import JsonApiLabelToOneLinkage from gooddata_api_client.model.json_api_list_document_data_source_info import JsonApiListDocumentDataSourceInfo from gooddata_api_client.model.json_api_list_document_database_instance import JsonApiListDocumentDatabaseInstance from gooddata_api_client.model.json_api_list_document_object_storage_info import JsonApiListDocumentObjectStorageInfo -from gooddata_api_client.model.json_api_list_document_pipe_table_summary import JsonApiListDocumentPipeTableSummary from gooddata_api_client.model.json_api_list_document_service_info import JsonApiListDocumentServiceInfo from gooddata_api_client.model.json_api_list_links import JsonApiListLinks from gooddata_api_client.model.json_api_list_meta import JsonApiListMeta @@ -863,15 +889,13 @@ from gooddata_api_client.model.json_api_memory_item_post_optional_id_document import JsonApiMemoryItemPostOptionalIdDocument from gooddata_api_client.model.json_api_metric_in import JsonApiMetricIn from gooddata_api_client.model.json_api_metric_in_attributes import JsonApiMetricInAttributes -from gooddata_api_client.model.json_api_metric_in_attributes_content import JsonApiMetricInAttributesContent +from gooddata_api_client.model.json_api_metric_in_attributes_conditional_formatting import JsonApiMetricInAttributesConditionalFormatting from gooddata_api_client.model.json_api_metric_in_document import JsonApiMetricInDocument from gooddata_api_client.model.json_api_metric_linkage import JsonApiMetricLinkage from gooddata_api_client.model.json_api_metric_out import JsonApiMetricOut from gooddata_api_client.model.json_api_metric_out_attributes import JsonApiMetricOutAttributes from gooddata_api_client.model.json_api_metric_out_document import JsonApiMetricOutDocument -from gooddata_api_client.model.json_api_metric_out_includes import JsonApiMetricOutIncludes from gooddata_api_client.model.json_api_metric_out_list import JsonApiMetricOutList -from gooddata_api_client.model.json_api_metric_out_relationships import JsonApiMetricOutRelationships from gooddata_api_client.model.json_api_metric_out_with_links import JsonApiMetricOutWithLinks from gooddata_api_client.model.json_api_metric_patch import JsonApiMetricPatch from gooddata_api_client.model.json_api_metric_patch_attributes import JsonApiMetricPatchAttributes @@ -952,6 +976,45 @@ 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_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 +from gooddata_api_client.model.json_api_report_out import JsonApiReportOut +from gooddata_api_client.model.json_api_report_out_attributes import JsonApiReportOutAttributes +from gooddata_api_client.model.json_api_report_out_document import JsonApiReportOutDocument +from gooddata_api_client.model.json_api_report_out_list import JsonApiReportOutList +from gooddata_api_client.model.json_api_report_out_with_links import JsonApiReportOutWithLinks +from gooddata_api_client.model.json_api_report_page_layout_in import JsonApiReportPageLayoutIn +from gooddata_api_client.model.json_api_report_page_layout_in_attributes import JsonApiReportPageLayoutInAttributes +from gooddata_api_client.model.json_api_report_page_layout_in_document import JsonApiReportPageLayoutInDocument +from gooddata_api_client.model.json_api_report_page_layout_out import JsonApiReportPageLayoutOut +from gooddata_api_client.model.json_api_report_page_layout_out_attributes import JsonApiReportPageLayoutOutAttributes +from gooddata_api_client.model.json_api_report_page_layout_out_document import JsonApiReportPageLayoutOutDocument +from gooddata_api_client.model.json_api_report_page_layout_out_list import JsonApiReportPageLayoutOutList +from gooddata_api_client.model.json_api_report_page_layout_out_with_links import JsonApiReportPageLayoutOutWithLinks +from gooddata_api_client.model.json_api_report_page_layout_patch import JsonApiReportPageLayoutPatch +from gooddata_api_client.model.json_api_report_page_layout_patch_attributes import JsonApiReportPageLayoutPatchAttributes +from gooddata_api_client.model.json_api_report_page_layout_patch_document import JsonApiReportPageLayoutPatchDocument +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id import JsonApiReportPageLayoutPostOptionalId +from gooddata_api_client.model.json_api_report_page_layout_post_optional_id_document import JsonApiReportPageLayoutPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_patch import JsonApiReportPatch +from gooddata_api_client.model.json_api_report_patch_attributes import JsonApiReportPatchAttributes +from gooddata_api_client.model.json_api_report_patch_document import JsonApiReportPatchDocument +from gooddata_api_client.model.json_api_report_post_optional_id import JsonApiReportPostOptionalId +from gooddata_api_client.model.json_api_report_post_optional_id_document import JsonApiReportPostOptionalIdDocument +from gooddata_api_client.model.json_api_report_template_in import JsonApiReportTemplateIn +from gooddata_api_client.model.json_api_report_template_in_attributes import JsonApiReportTemplateInAttributes +from gooddata_api_client.model.json_api_report_template_in_document import JsonApiReportTemplateInDocument +from gooddata_api_client.model.json_api_report_template_out import JsonApiReportTemplateOut +from gooddata_api_client.model.json_api_report_template_out_attributes import JsonApiReportTemplateOutAttributes +from gooddata_api_client.model.json_api_report_template_out_document import JsonApiReportTemplateOutDocument +from gooddata_api_client.model.json_api_report_template_out_list import JsonApiReportTemplateOutList +from gooddata_api_client.model.json_api_report_template_out_with_links import JsonApiReportTemplateOutWithLinks +from gooddata_api_client.model.json_api_report_template_patch import JsonApiReportTemplatePatch +from gooddata_api_client.model.json_api_report_template_patch_attributes import JsonApiReportTemplatePatchAttributes +from gooddata_api_client.model.json_api_report_template_patch_document import JsonApiReportTemplatePatchDocument +from gooddata_api_client.model.json_api_report_template_post_optional_id import JsonApiReportTemplatePostOptionalId +from gooddata_api_client.model.json_api_report_template_post_optional_id_document import JsonApiReportTemplatePostOptionalIdDocument from gooddata_api_client.model.json_api_theme_in import JsonApiThemeIn from gooddata_api_client.model.json_api_theme_in_document import JsonApiThemeInDocument from gooddata_api_client.model.json_api_theme_out import JsonApiThemeOut @@ -1006,6 +1069,7 @@ from gooddata_api_client.model.json_api_user_patch import JsonApiUserPatch from gooddata_api_client.model.json_api_user_patch_document import JsonApiUserPatchDocument from gooddata_api_client.model.json_api_user_setting_in import JsonApiUserSettingIn +from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes from gooddata_api_client.model.json_api_user_setting_in_document import JsonApiUserSettingInDocument from gooddata_api_client.model.json_api_user_setting_out import JsonApiUserSettingOut from gooddata_api_client.model.json_api_user_setting_out_document import JsonApiUserSettingOutDocument @@ -1015,6 +1079,7 @@ from gooddata_api_client.model.json_api_user_to_one_linkage import JsonApiUserToOneLinkage from gooddata_api_client.model.json_api_visualization_object_in import JsonApiVisualizationObjectIn from gooddata_api_client.model.json_api_visualization_object_in_attributes import JsonApiVisualizationObjectInAttributes +from gooddata_api_client.model.json_api_visualization_object_in_attributes_conditional_formatting import JsonApiVisualizationObjectInAttributesConditionalFormatting from gooddata_api_client.model.json_api_visualization_object_in_document import JsonApiVisualizationObjectInDocument from gooddata_api_client.model.json_api_visualization_object_linkage import JsonApiVisualizationObjectLinkage from gooddata_api_client.model.json_api_visualization_object_out import JsonApiVisualizationObjectOut @@ -1122,7 +1187,6 @@ from gooddata_api_client.model.json_api_workspace_theme_patch_document import JsonApiWorkspaceThemePatchDocument from gooddata_api_client.model.json_api_workspace_to_one_linkage import JsonApiWorkspaceToOneLinkage from gooddata_api_client.model.json_node import JsonNode -from gooddata_api_client.model.key_config import KeyConfig from gooddata_api_client.model.key_drivers_dimension import KeyDriversDimension from gooddata_api_client.model.key_drivers_request import KeyDriversRequest from gooddata_api_client.model.key_drivers_response import KeyDriversResponse @@ -1144,10 +1208,12 @@ from gooddata_api_client.model.local_identifier import LocalIdentifier from gooddata_api_client.model.locale_request import LocaleRequest from gooddata_api_client.model.manage_attribute_permissions_request_inner import ManageAttributePermissionsRequestInner +from gooddata_api_client.model.manage_computed_attribute_permissions_request_inner import ManageComputedAttributePermissionsRequestInner from gooddata_api_client.model.manage_dashboard_permissions_request_inner import ManageDashboardPermissionsRequestInner from gooddata_api_client.model.manage_fact_permissions_request_inner import ManageFactPermissionsRequestInner from gooddata_api_client.model.manage_label_permissions_request_inner import ManageLabelPermissionsRequestInner from gooddata_api_client.model.manage_metric_permissions_request_inner import ManageMetricPermissionsRequestInner +from gooddata_api_client.model.manage_visualization_permissions_request_inner import ManageVisualizationPermissionsRequestInner from gooddata_api_client.model.match_attribute_filter import MatchAttributeFilter from gooddata_api_client.model.match_attribute_filter_match_attribute_filter import MatchAttributeFilterMatchAttributeFilter from gooddata_api_client.model.matomo_service import MatomoService @@ -1161,7 +1227,6 @@ from gooddata_api_client.model.measure_value_filter import MeasureValueFilter from gooddata_api_client.model.memory_item_created_by_users import MemoryItemCreatedByUsers from gooddata_api_client.model.memory_item_user import MemoryItemUser -from gooddata_api_client.model.metric import Metric from gooddata_api_client.model.metric_definition_override import MetricDefinitionOverride from gooddata_api_client.model.metric_permissions import MetricPermissions from gooddata_api_client.model.metric_permissions_assignment import MetricPermissionsAssignment @@ -1185,10 +1250,9 @@ from gooddata_api_client.model.notifications_meta_total import NotificationsMetaTotal from gooddata_api_client.model.number_constraints import NumberConstraints from gooddata_api_client.model.number_parameter_definition import NumberParameterDefinition +from gooddata_api_client.model.object_conditional_formatting import ObjectConditionalFormatting from gooddata_api_client.model.object_links import ObjectLinks from gooddata_api_client.model.object_links_container import ObjectLinksContainer -from gooddata_api_client.model.object_reference import ObjectReference -from gooddata_api_client.model.object_reference_group import ObjectReferenceGroup from gooddata_api_client.model.object_storage_info import ObjectStorageInfo from gooddata_api_client.model.open_ai_provider_config import OpenAIProviderConfig from gooddata_api_client.model.open_ai_api_key_auth import OpenAiApiKeyAuth @@ -1213,7 +1277,6 @@ from gooddata_api_client.model.parameter_definition import ParameterDefinition from gooddata_api_client.model.parameter_item import ParameterItem from gooddata_api_client.model.parameter_value import ParameterValue -from gooddata_api_client.model.partition_config import PartitionConfig from gooddata_api_client.model.pdf_table_style import PdfTableStyle from gooddata_api_client.model.pdf_table_style_property import PdfTableStyleProperty from gooddata_api_client.model.pdm_ldm_request import PdmLdmRequest @@ -1222,8 +1285,6 @@ from gooddata_api_client.model.permissions_assignment import PermissionsAssignment from gooddata_api_client.model.permissions_for_assignee import PermissionsForAssignee from gooddata_api_client.model.permissions_for_assignee_rule import PermissionsForAssigneeRule -from gooddata_api_client.model.pipe_table import PipeTable -from gooddata_api_client.model.pipe_table_summary import PipeTableSummary from gooddata_api_client.model.platform_usage import PlatformUsage from gooddata_api_client.model.platform_usage_request import PlatformUsageRequest from gooddata_api_client.model.pop_dataset import PopDataset @@ -1235,7 +1296,6 @@ from gooddata_api_client.model.pop_measure_definition import PopMeasureDefinition from gooddata_api_client.model.positive_attribute_filter import PositiveAttributeFilter from gooddata_api_client.model.positive_attribute_filter_positive_attribute_filter import PositiveAttributeFilterPositiveAttributeFilter -from gooddata_api_client.model.primary_key_config import PrimaryKeyConfig from gooddata_api_client.model.profile import Profile from gooddata_api_client.model.profile_features import ProfileFeatures from gooddata_api_client.model.profile_links import ProfileLinks @@ -1243,7 +1303,6 @@ 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 -from gooddata_api_client.model.random_distribution_config import RandomDistributionConfig from gooddata_api_client.model.range import Range from gooddata_api_client.model.range_condition import RangeCondition from gooddata_api_client.model.range_condition_range import RangeConditionRange @@ -1260,45 +1319,32 @@ from gooddata_api_client.model.read_csv_file_manifests_request import ReadCsvFileManifestsRequest from gooddata_api_client.model.read_csv_file_manifests_request_item import ReadCsvFileManifestsRequestItem from gooddata_api_client.model.read_csv_file_manifests_response import ReadCsvFileManifestsResponse -from gooddata_api_client.model.reasoning import Reasoning -from gooddata_api_client.model.reasoning_step import ReasoningStep from gooddata_api_client.model.reference_identifier import ReferenceIdentifier from gooddata_api_client.model.reference_source_column import ReferenceSourceColumn -from gooddata_api_client.model.refresh_partition_request import RefreshPartitionRequest from gooddata_api_client.model.relative import Relative 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_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 from gooddata_api_client.model.resolve_settings_request import ResolveSettingsRequest -from gooddata_api_client.model.resolved_llm import ResolvedLlm -from gooddata_api_client.model.resolved_llm_provider import ResolvedLlmProvider -from gooddata_api_client.model.resolved_llm_provider_all_of import ResolvedLlmProviderAllOf -from gooddata_api_client.model.resolved_llms import ResolvedLlms -from gooddata_api_client.model.resolved_llms_data import ResolvedLlmsData from gooddata_api_client.model.resolved_setting import ResolvedSetting from gooddata_api_client.model.rest_api_identifier import RestApiIdentifier +from gooddata_api_client.model.restricted_object import RestrictedObject from gooddata_api_client.model.result_cache_metadata import ResultCacheMetadata from gooddata_api_client.model.result_dimension import ResultDimension from gooddata_api_client.model.result_dimension_header import ResultDimensionHeader from gooddata_api_client.model.result_spec import ResultSpec -from gooddata_api_client.model.rich_text_widget_descriptor import RichTextWidgetDescriptor -from gooddata_api_client.model.route_result import RouteResult from gooddata_api_client.model.rsa_specification import RsaSpecification from gooddata_api_client.model.rule_permission import RulePermission from gooddata_api_client.model.run_service_command_request import RunServiceCommandRequest from gooddata_api_client.model.running_section import RunningSection -from gooddata_api_client.model.saved_visualization import SavedVisualization from gooddata_api_client.model.scan_request import ScanRequest from gooddata_api_client.model.scan_result_pdm import ScanResultPdm from gooddata_api_client.model.scan_sql_request import ScanSqlRequest from gooddata_api_client.model.scan_sql_response import ScanSqlResponse from gooddata_api_client.model.schedule_cache_retention import ScheduleCacheRetention -from gooddata_api_client.model.search_relationship_object import SearchRelationshipObject -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult -from gooddata_api_client.model.search_result_object import SearchResultObject from gooddata_api_client.model.section_slide_template import SectionSlideTemplate from gooddata_api_client.model.service_info import ServiceInfo from gooddata_api_client.model.set_certification_request import SetCertificationRequest @@ -1319,6 +1365,8 @@ from gooddata_api_client.model.sort_key_value_value import SortKeyValueValue from gooddata_api_client.model.source_reference_identifier import SourceReferenceIdentifier from gooddata_api_client.model.sql_column import SqlColumn +from gooddata_api_client.model.sql_flow_input import SqlFlowInput +from gooddata_api_client.model.sql_flow_input_all_of import SqlFlowInputAllOf from gooddata_api_client.model.sql_query import SqlQuery from gooddata_api_client.model.sql_query_all_of import SqlQueryAllOf from gooddata_api_client.model.static_features import StaticFeatures @@ -1328,7 +1376,6 @@ from gooddata_api_client.model.string_parameter_definition import StringParameterDefinition from gooddata_api_client.model.succeeded_operation import SucceededOperation from gooddata_api_client.model.succeeded_operation_all_of import SucceededOperationAllOf -from gooddata_api_client.model.suggestion import Suggestion from gooddata_api_client.model.switch_identity_provider_request import SwitchIdentityProviderRequest from gooddata_api_client.model.table import Table from gooddata_api_client.model.table_all_of import TableAllOf @@ -1353,8 +1400,6 @@ from gooddata_api_client.model.test_query_duration import TestQueryDuration from gooddata_api_client.model.test_request import TestRequest from gooddata_api_client.model.test_response import TestResponse -from gooddata_api_client.model.thought import Thought -from gooddata_api_client.model.time_slice_partition_config import TimeSlicePartitionConfig from gooddata_api_client.model.total import Total from gooddata_api_client.model.total_dimension import TotalDimension from gooddata_api_client.model.total_execution_result_header import TotalExecutionResultHeader @@ -1363,14 +1408,11 @@ from gooddata_api_client.model.trending_objects_result import TrendingObjectsResult from gooddata_api_client.model.trigger_automation_request import TriggerAutomationRequest from gooddata_api_client.model.trigger_quality_issues_calculation_response import TriggerQualityIssuesCalculationResponse -from gooddata_api_client.model.ui_context import UIContext -from gooddata_api_client.model.unique_key_config import UniqueKeyConfig from gooddata_api_client.model.update_database_data_source_request import UpdateDatabaseDataSourceRequest from gooddata_api_client.model.update_database_data_source_response import UpdateDatabaseDataSourceResponse from gooddata_api_client.model.upload_file_response import UploadFileResponse from gooddata_api_client.model.upload_geo_collection_file_response import UploadGeoCollectionFileResponse from gooddata_api_client.model.user_assignee import UserAssignee -from gooddata_api_client.model.user_context import UserContext from gooddata_api_client.model.user_group_assignee import UserGroupAssignee from gooddata_api_client.model.user_group_identifier import UserGroupIdentifier from gooddata_api_client.model.user_group_permission import UserGroupPermission @@ -1389,23 +1431,18 @@ from gooddata_api_client.model.value import Value from gooddata_api_client.model.visible_filter import VisibleFilter from gooddata_api_client.model.visual_export_request import VisualExportRequest -from gooddata_api_client.model.visualization_config import VisualizationConfig from gooddata_api_client.model.visualization_object_execution import VisualizationObjectExecution -from gooddata_api_client.model.visualization_switcher_widget_descriptor import VisualizationSwitcherWidgetDescriptor +from gooddata_api_client.model.visualization_permissions import VisualizationPermissions +from gooddata_api_client.model.visualization_permissions_assignment import VisualizationPermissionsAssignment +from gooddata_api_client.model.visualization_permissions_for_assignee import VisualizationPermissionsForAssignee +from gooddata_api_client.model.visualization_permissions_for_assignee_rule import VisualizationPermissionsForAssigneeRule from gooddata_api_client.model.webhook import Webhook from gooddata_api_client.model.webhook_all_of import WebhookAllOf from gooddata_api_client.model.webhook_automation_info import WebhookAutomationInfo from gooddata_api_client.model.webhook_message import WebhookMessage from gooddata_api_client.model.webhook_message_data import WebhookMessageData from gooddata_api_client.model.webhook_recipient import WebhookRecipient -from gooddata_api_client.model.what_if_measure_adjustment_config import WhatIfMeasureAdjustmentConfig -from gooddata_api_client.model.what_if_scenario_config import WhatIfScenarioConfig -from gooddata_api_client.model.what_if_scenario_item import WhatIfScenarioItem -from gooddata_api_client.model.widget_descriptor import WidgetDescriptor from gooddata_api_client.model.widget_slides_template import WidgetSlidesTemplate -from gooddata_api_client.model.workflow_dashboard_summary_request_dto import WorkflowDashboardSummaryRequestDto -from gooddata_api_client.model.workflow_dashboard_summary_response_dto import WorkflowDashboardSummaryResponseDto -from gooddata_api_client.model.workflow_status_response_dto import WorkflowStatusResponseDto from gooddata_api_client.model.workspace_automation_identifier import WorkspaceAutomationIdentifier from gooddata_api_client.model.workspace_automation_management_bulk_request import WorkspaceAutomationManagementBulkRequest from gooddata_api_client.model.workspace_cache_settings import WorkspaceCacheSettings diff --git a/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py b/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py index 3d29b4d5a..df2f3a65a 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/catalog/workspace/entity_model/content_objects/workspace_setting.py @@ -5,7 +5,7 @@ from typing import Any, Union from attrs import Factory, define, field -from gooddata_api_client.model.json_api_organization_setting_in_attributes import JsonApiOrganizationSettingInAttributes +from gooddata_api_client.model.json_api_user_setting_in_attributes import JsonApiUserSettingInAttributes from gooddata_api_client.model.json_api_workspace_setting_in import JsonApiWorkspaceSettingIn from gooddata_api_client.model.json_api_workspace_setting_in_document import JsonApiWorkspaceSettingInDocument from gooddata_api_client.model.json_api_workspace_setting_out import JsonApiWorkspaceSettingOut @@ -22,7 +22,7 @@ class CatalogWorkspaceSetting(Base): id: str = field(default=None) setting_type: str = field( - validator=functools.partial(value_in_allowed, client_class=JsonApiOrganizationSettingInAttributes) + validator=functools.partial(value_in_allowed, client_class=JsonApiUserSettingInAttributes) ) content: dict = field( repr=False, @@ -33,8 +33,8 @@ class CatalogWorkspaceSetting(Base): def client_class() -> type[JsonApiWorkspaceSettingOut]: return JsonApiWorkspaceSettingOut - def _attributes(self) -> JsonApiOrganizationSettingInAttributes: - return JsonApiOrganizationSettingInAttributes( + def _attributes(self) -> JsonApiUserSettingInAttributes: + return JsonApiUserSettingInAttributes( content=self.content, type=self.setting_type, ) diff --git a/packages/gooddata-sdk/src/gooddata_sdk/compute/model/base.py b/packages/gooddata-sdk/src/gooddata_sdk/compute/model/base.py index 27915393a..e6ef23afd 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/compute/model/base.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/compute/model/base.py @@ -28,7 +28,7 @@ def as_afm_id(self) -> afm_models.AfmObjectIdentifier: def as_afm_id_label(self) -> afm_models.AfmObjectIdentifierLabel: return afm_models.AfmObjectIdentifierLabel( - identifier=afm_models.AfmObjectIdentifierLabelIdentifier(id=self._id) + identifier=afm_models.AfmObjectIdentifierLabelIdentifier(id=self._id, type="label") ) def as_afm_id_dataset(self) -> afm_models.AfmObjectIdentifierDataset: diff --git a/packages/gooddata-sdk/src/gooddata_sdk/compute/service.py b/packages/gooddata-sdk/src/gooddata_sdk/compute/service.py index e8aefa964..83a5c064a 100644 --- a/packages/gooddata-sdk/src/gooddata_sdk/compute/service.py +++ b/packages/gooddata-sdk/src/gooddata_sdk/compute/service.py @@ -1,20 +1,12 @@ # (C) 2022 GoodData Corporation from __future__ import annotations -import json import logging from collections.abc import Iterator from typing import Any, Union from gooddata_api_client import ApiException from gooddata_api_client.model.afm_cancel_tokens import AfmCancelTokens -from gooddata_api_client.model.chat_history_request import ChatHistoryRequest -from gooddata_api_client.model.chat_history_result import ChatHistoryResult -from gooddata_api_client.model.chat_request import ChatRequest -from gooddata_api_client.model.chat_result import ChatResult -from gooddata_api_client.model.saved_visualization import SavedVisualization -from gooddata_api_client.model.search_request import SearchRequest -from gooddata_api_client.model.search_result import SearchResult from gooddata_sdk.client import GoodDataApiClient from gooddata_sdk.compute.model.execution import ( @@ -27,6 +19,10 @@ logger = logging.getLogger(__name__) +_LEGACY_AI_REMOVED = ( + "The legacy AI chat and search endpoints were removed from the GoodData backend; use the AI Assistant API." +) + class ComputeService: """ @@ -100,9 +96,7 @@ def retrieve_result_cache_metadata(self, workspace_id: str, result_id: str) -> R ) return ResultCacheMetadata(result_cache_metadata=result_cache_metadata) - def build_exec_def_from_chat_result( - self, chat_result: ChatResult, is_cancellable: bool = False - ) -> ExecutionDefinition: + def build_exec_def_from_chat_result(self, chat_result: Any, is_cancellable: bool = False) -> ExecutionDefinition: """ Build execution definition from chat result. @@ -135,7 +129,7 @@ def build_exec_def_from_chat_result( is_cancellable=is_cancellable, ) - def ai_chat(self, workspace_id: str, question: str) -> ChatResult: + def ai_chat(self, workspace_id: str, question: str) -> Any: """ Chat with AI in GoodData workspace. @@ -144,21 +138,11 @@ def ai_chat(self, workspace_id: str, question: str) -> ChatResult: question (str): question for the AI Returns: ChatResult: Chat response + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - chat_request = ChatRequest(question=question) - response = self._actions_api.ai_chat(workspace_id, chat_request, _check_return_type=False) - return response - - def _parse_sse_events(self, raw: str) -> Iterator[Any]: - """Helper to parse SSE events and yield JSON from data lines.""" - events = raw.split("\n\n") - for event in events: - for line in event.split("\n"): - if line.startswith("data:"): - try: - yield json.loads(line[5:].strip()) - except json.JSONDecodeError: - continue + raise NotImplementedError(_LEGACY_AI_REMOVED) def ai_chat_stream(self, workspace_id: str, question: str) -> Iterator[Any]: """ @@ -169,28 +153,18 @@ def ai_chat_stream(self, workspace_id: str, question: str) -> Iterator[Any]: question (str): question for the AI Returns: Iterator[Any]: Yields parsed JSON objects from each SSE event's data field + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - chat_request = ChatRequest(question=question) - response = self._actions_api.ai_chat_stream( - workspace_id, chat_request, _check_return_type=False, _preload_content=False - ) - buffer = "" - try: - for chunk in response.stream(decode_content=True): - if chunk: - buffer += chunk.decode("utf-8") - *events, buffer = buffer.split("\n\n") - for event in events: - yield from self._parse_sse_events(event) - finally: - response.release_conn() + raise NotImplementedError(_LEGACY_AI_REMOVED) def get_ai_chat_history( self, workspace_id: str, chat_history_interaction_id: str = "", thread_id_suffix: str = "", - ) -> ChatHistoryResult: + ) -> Any: """ Get chat history with AI in GoodData workspace. @@ -200,12 +174,11 @@ def get_ai_chat_history( thread_id_suffix (str): suffix to identify a specific chat thread. If provided, chat_history_interaction_id is ignored. Defaults to "". Returns: ChatHistoryResult: Chat history response containing interactions and other metadata + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - chat_history_request = ChatHistoryRequest( - chat_history_interaction_id=chat_history_interaction_id, reset=False, thread_id_suffix=thread_id_suffix - ) - response = self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) - return response + raise NotImplementedError(_LEGACY_AI_REMOVED) def reset_ai_chat_history(self, workspace_id: str) -> None: """ @@ -213,9 +186,11 @@ def reset_ai_chat_history(self, workspace_id: str) -> None: Args: workspace_id (str): workspace identifier + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - chat_history_request = ChatHistoryRequest(reset=True) - self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + raise NotImplementedError(_LEGACY_AI_REMOVED) def set_ai_chat_history_feedback( self, @@ -232,14 +207,11 @@ def set_ai_chat_history_feedback( user_feedback (str): feedback to provide ("POSITIVE", "NEGATIVE" or "NONE"). chat_history_interaction_id (str): interaction id to provide feedback for. thread_id_suffix (str): suffix to identify a specific chat thread. Defaults to "". + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - chat_history_request = ChatHistoryRequest( - user_feedback=user_feedback, - chat_history_interaction_id=chat_history_interaction_id, - thread_id_suffix=thread_id_suffix, - reset=False, - ) - self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + raise NotImplementedError(_LEGACY_AI_REMOVED) def set_ai_chat_history_saved_visualization( self, @@ -258,18 +230,11 @@ def set_ai_chat_history_saved_visualization( saved_visualization_id (str): id of the saved visualization chat_history_interaction_id (str): interaction id to set saved visualization for. thread_id_suffix (str): suffix to identify a specific chat thread. Defaults to "". + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - saved_visualization = SavedVisualization( - created_visualization_id=created_visualization_id, - saved_visualization_id=saved_visualization_id, - ) - chat_history_request = ChatHistoryRequest( - saved_visualization=saved_visualization, - chat_history_interaction_id=chat_history_interaction_id, - thread_id_suffix=thread_id_suffix, - reset=False, - ) - self._actions_api.ai_chat_history(workspace_id, chat_history_request, _check_return_type=False) + raise NotImplementedError(_LEGACY_AI_REMOVED) def search_ai( self, @@ -280,7 +245,7 @@ def search_ai( object_types: list[str] | None = None, relevant_score_threshold: float | None = None, title_to_descriptor_ratio: float | None = None, - ) -> SearchResult: + ) -> Any: """ Search for metadata objects using similarity search. @@ -299,21 +264,11 @@ def search_ai( Note: Default values for optional parameters are documented in the AI Search endpoint of the GoodData API. + + Raises: + NotImplementedError: The backend no longer serves this endpoint. """ - search_params: dict[str, Any] = {} - if deep_search is not None: - search_params["deep_search"] = deep_search - if limit is not None: - search_params["limit"] = limit - if object_types is not None: - search_params["object_types"] = object_types - if relevant_score_threshold is not None: - search_params["relevant_score_threshold"] = relevant_score_threshold - if title_to_descriptor_ratio is not None: - search_params["title_to_descriptor_ratio"] = title_to_descriptor_ratio - search_request = SearchRequest(question=question, **search_params) - response = self._actions_api.ai_search(workspace_id, search_request, _check_return_type=False) - return response + raise NotImplementedError(_LEGACY_AI_REMOVED) def cancel_executions(self, executions: dict[str, dict[str, str]]) -> None: """ diff --git a/schemas/gooddata-afm-client.json b/schemas/gooddata-afm-client.json index 5281f6a6e..336d68381 100644 --- a/schemas/gooddata-afm-client.json +++ b/schemas/gooddata-afm-client.json @@ -127,7 +127,6 @@ "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", "example": "2012-05", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" }, "granularity": { @@ -184,7 +183,6 @@ "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", "example": "2012-08", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" } }, @@ -217,29 +215,6 @@ ], "type": "object" }, - "ActiveObjectIdentification": { - "description": "Object, with which the user is actively working.", - "properties": { - "id": { - "description": "Object ID.", - "type": "string" - }, - "type": { - "description": "Object type, e.g. dashboard.", - "type": "string" - }, - "workspaceId": { - "description": "Workspace ID.", - "type": "string" - } - }, - "required": [ - "id", - "type", - "workspaceId" - ], - "type": "object" - }, "AddDatabaseDataSourceRequest": { "description": "Request to add a data source to an AI Lake Database instance", "properties": { @@ -315,6 +290,34 @@ ], "type": "object" }, + "AfmFlowInput": { + "allOf": [ + { + "properties": { + "execution": { + "$ref": "#/components/schemas/AFM" + }, + "settings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "type": { + "description": "Type of the input.", + "enum": [ + "afm" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Computes an AFM as /afm/execute does, and reads its rows as a table. It has a column for each attribute and each measure of the AFM, named by its local identifier, the attributes first. Each attribute must use a label of its own.", + "required": [ + "execution", + "type" + ], + "type": "object" + }, "AfmIdentifier": { "description": "Reference to the attribute label to which the filter should be applied.", "oneOf": [ @@ -354,6 +357,7 @@ "enum": [ "analyticalDashboard", "attribute", + "computedAttribute", "dashboardPlugin", "dataset", "fact", @@ -423,7 +427,8 @@ "attribute", "label", "fact", - "metric" + "metric", + "computedAttribute" ], "type": "string" } @@ -480,7 +485,8 @@ }, "type": { "enum": [ - "label" + "label", + "computedAttribute" ], "type": "string" } @@ -574,7 +580,8 @@ "enum": [ "facts", "attributes", - "measures" + "measures", + "computedAttributes" ], "example": "facts", "type": "string" @@ -604,54 +611,6 @@ ], "type": "object" }, - "AggregateKeyConfig": { - "description": "Aggregate key model — pre-aggregates rows sharing the same key columns.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "aggregate" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AiUsageMetadataItem": { - "description": "AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).", - "properties": { - "counterType": { - "description": "Type of usage counter, e.g. AI_QUERIES.", - "type": "string" - }, - "currentValue": { - "description": "Current usage value after this request.", - "format": "int64", - "type": "integer" - }, - "limit": { - "description": "Entitlement limit. 0 means unlimited.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "counterType", - "currentValue", - "limit" - ], - "type": "object" - }, "AllTimeDateFilter": { "description": "An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled.", "properties": { @@ -736,49 +695,6 @@ ], "type": "object" }, - "AllowedRelationshipType": { - "description": "Allowed relationship type combination.", - "properties": { - "allowOrphans": { - "default": true, - "description": "If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).", - "type": "boolean" - }, - "sourceType": { - "description": "Source object type (e.g., 'dashboard', 'visualization', 'metric').", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "targetType": { - "description": "Target object type (e.g., 'visualization', 'metric', 'attribute').", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - } - }, - "required": [ - "sourceType", - "targetType" - ], - "type": "object" - }, "AnalyzeStatisticsRequest": { "description": "Request to run ANALYZE TABLE for tables in a database instance", "properties": { @@ -793,24 +709,6 @@ }, "type": "object" }, - "AnomalyDetectionConfig": { - "description": "Anomaly detection configuration.", - "properties": { - "sensitivity": { - "description": "Outlier sensitivity level.", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - } - }, - "required": [ - "sensitivity" - ], - "type": "object" - }, "AnomalyDetectionRequest": { "properties": { "sensitivity": { @@ -1156,58 +1054,6 @@ ], "type": "object" }, - "AttributeNegativeFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "exclude": { - "items": { - "type": "string" - }, - "type": "array" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "exclude", - "using" - ], - "type": "object" - }, - "AttributePositiveFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "include": { - "items": { - "type": "string" - }, - "type": "array" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "include", - "using" - ], - "type": "object" - }, "AttributeResultHeader": { "description": "Header containing the information related to attributes.", "properties": { @@ -1438,75 +1284,6 @@ ], "type": "object" }, - "CertificationInfo": { - "description": "Certification state of the object. Who certified and when are never exposed here.", - "properties": { - "certificationMessage": { - "description": "Optional message describing the certification.", - "type": "string" - }, - "status": { - "description": "Certification status, e.g. CERTIFIED.", - "type": "string" - } - }, - "required": [ - "status" - ], - "type": "object" - }, - "ChangeAnalysisParams": { - "description": "Change analysis specification.", - "properties": { - "analyzedPeriod": { - "description": "The analyzed time period", - "type": "string" - }, - "attributes": { - "description": "Attributes to analyze for significant changes", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "dateAttribute": { - "$ref": "#/components/schemas/AttributeItem" - }, - "filters": { - "description": "Optional filters to apply", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "measure": { - "$ref": "#/components/schemas/MeasureItem" - }, - "measureTitle": { - "description": "The title of the measure being analyzed", - "type": "string" - }, - "referencePeriod": { - "description": "The reference time period", - "type": "string" - }, - "useSmartAttributeSelection": { - "description": "Whether to use smart attribute selection", - "type": "boolean" - } - }, - "required": [ - "analyzedPeriod", - "attributes", - "dateAttribute", - "filters", - "measure", - "measureTitle", - "referencePeriod", - "useSmartAttributeSelection" - ], - "type": "object" - }, "ChangeAnalysisRequest": { "description": "Request for change analysis computation", "properties": { @@ -1603,375 +1380,54 @@ ], "type": "object" }, - "ChatHistoryInteraction": { - "description": "List of chat history interactions.", + "ClusteringRequest": { "properties": { - "changeAnalysisParams": { - "$ref": "#/components/schemas/ChangeAnalysisParams" - }, - "chatHistoryInteractionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "type": "string" - }, - "createdVisualizations": { - "$ref": "#/components/schemas/CreatedVisualizations" - }, - "errorResponse": { - "description": "Error response in anything fails.", - "type": "string" - }, - "foundObjects": { - "$ref": "#/components/schemas/FoundObjects" - }, - "interactionFinished": { - "description": "Has the interaction already finished? Can be used for polling when interaction is in progress.", - "type": "boolean" - }, - "question": { - "description": "User question", - "maxLength": 2000, - "type": "string" - }, - "reasoning": { - "$ref": "#/components/schemas/Reasoning" - }, - "routing": { - "$ref": "#/components/schemas/RouteResult" - }, - "semanticSearch": { - "$ref": "#/components/schemas/SearchResult" - }, - "textResponse": { - "description": "Text response for general questions.", - "type": "string" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" + "numberOfClusters": { + "description": "Number of clusters to create", + "format": "int32", + "minimum": 1, + "type": "integer" }, - "userFeedback": { - "description": "User feedback.", - "enum": [ - "POSITIVE", - "NEGATIVE", - "NONE" - ], - "type": "string" + "threshold": { + "default": 0.03, + "description": "Threshold used for algorithm", + "exclusiveMinimum": true, + "format": "double", + "minimum": 0, + "type": "number" } }, "required": [ - "chatHistoryInteractionId", - "interactionFinished", - "question", - "routing" + "numberOfClusters" ], "type": "object" }, - "ChatHistoryRequest": { + "ClusteringResult": { "properties": { - "chatHistoryInteractionId": { - "description": "Return chat history records only after this interaction ID. If empty, complete chat history is returned.", - "type": "string" + "attribute": { + "items": { + "type": "object" + }, + "type": "array" }, - "reset": { - "description": "User feedback.", - "type": "boolean" - }, - "responseState": { - "description": "Response state indicating the outcome of the AI interaction.", - "enum": [ - "SUCCESSFUL", - "UNEXPECTED_ERROR", - "NOT_FOUND_ATTRIBUTES", - "TOO_MANY_DATA_POINTS", - "NO_DATA", - "NO_RESULTS", - "OUT_OF_TOPIC" - ], - "type": "string" - }, - "savedVisualization": { - "$ref": "#/components/schemas/SavedVisualization" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "userFeedback": { - "description": "User feedback.", - "enum": [ - "POSITIVE", - "NEGATIVE", - "NONE" - ], - "type": "string" - }, - "userTextFeedback": { - "description": "User text feedback for the interaction.", - "type": "string" - } - }, - "type": "object" - }, - "ChatHistoryResult": { - "properties": { - "interactions": { - "description": "List of chat history interactions.", - "items": { - "$ref": "#/components/schemas/ChatHistoryInteraction" - }, - "type": "array" - }, - "threadId": { - "description": "The conversation thread ID.", - "type": "string" - } - }, - "required": [ - "interactions", - "threadId" - ], - "type": "object" - }, - "ChatRequest": { - "properties": { - "allowedRelationshipTypes": { - "description": "Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).", - "items": { - "$ref": "#/components/schemas/AllowedRelationshipType" - }, - "type": "array" - }, - "includeHidden": { - "default": false, - "description": "If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.", - "type": "boolean" - }, - "limitCreate": { - "default": 3, - "description": "Maximum number of created results.", - "format": "int32", - "type": "integer" - }, - "limitCreateContext": { - "default": 10, - "description": "Maximum number of relevant objects included into context for LLM (for each object type).", - "format": "int32", - "type": "integer" - }, - "limitSearch": { - "default": 5, - "description": "Maximum number of search results.", - "format": "int32", - "type": "integer" - }, - "objectTypes": { - "description": "List of object types to filter the search and visualization building. If empty or null, all object types are considered.", - "items": { - "description": "Object type to filter.", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "type": "array" - }, - "question": { - "description": "User question", - "maxLength": 2000, - "type": "string" - }, - "relevantScoreThreshold": { - "default": 0.45, - "description": "Score, above which we return found objects. Below this score objects are not relevant.", - "format": "double", - "type": "number" - }, - "searchScoreThreshold": { - "default": 0.9, - "description": "Score, above which we return found object(s) and don't call LLM to create new objects.", - "format": "double", - "type": "number" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "titleToDescriptorRatio": { - "default": 0.7, - "description": "Temporary for experiments. Ratio of title score to descriptor score.", - "format": "double", - "type": "number" - }, - "userContext": { - "$ref": "#/components/schemas/UserContext" - } - }, - "required": [ - "question" - ], - "type": "object" - }, - "ChatResult": { - "properties": { - "changeAnalysisParams": { - "$ref": "#/components/schemas/ChangeAnalysisParams" - }, - "chatHistoryInteractionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "type": "string" - }, - "createdVisualizations": { - "$ref": "#/components/schemas/CreatedVisualizations" - }, - "errorResponse": { - "description": "Error response in anything fails.", - "type": "string" - }, - "foundObjects": { - "$ref": "#/components/schemas/FoundObjects" - }, - "reasoning": { - "$ref": "#/components/schemas/Reasoning" - }, - "routing": { - "$ref": "#/components/schemas/RouteResult" - }, - "semanticSearch": { - "$ref": "#/components/schemas/SearchResult" - }, - "textResponse": { - "description": "Text response for general questions.", - "type": "string" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "usage": { - "description": "AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).", - "items": { - "$ref": "#/components/schemas/AiUsageMetadataItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "ChatUsageResponse": { - "properties": { - "interactionCount": { - "description": "Number of interactions in the time window", - "format": "int32", - "type": "integer" - }, - "interactionLimit": { - "description": "Maximum number of interactions in the time window any user can do in the workspace", - "format": "int32", - "type": "integer" - }, - "timeWindowHours": { - "description": "Time window in hours", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "interactionCount", - "interactionLimit", - "timeWindowHours" - ], - "type": "object" - }, - "ClusteringConfig": { - "description": "Clustering configuration.", - "properties": { - "numberOfClusters": { - "description": "Number of clusters to create", - "format": "int32", - "type": "integer" - }, - "threshold": { - "description": "Clustering algorithm threshold", - "format": "float", - "type": "number" - } - }, - "required": [ - "numberOfClusters", - "threshold" - ], - "type": "object" - }, - "ClusteringRequest": { - "properties": { - "numberOfClusters": { - "description": "Number of clusters to create", - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "threshold": { - "default": 0.03, - "description": "Threshold used for algorithm", - "exclusiveMinimum": true, - "format": "double", - "minimum": 0, - "type": "number" - } - }, - "required": [ - "numberOfClusters" - ], - "type": "object" - }, - "ClusteringResult": { - "properties": { - "attribute": { - "items": { - "type": "object" - }, - "type": "array" - }, - "clusters": { - "items": { - "format": "int32", - "nullable": true, - "type": "integer" - }, - "type": "array" - }, - "xCoord": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array", - "writeOnly": true + "clusters": { + "items": { + "format": "int32", + "nullable": true, + "type": "integer" + }, + "type": "array" }, "xcoord": { - "items": { - "type": "number" - }, - "type": "array" - }, - "yCoord": { "items": { "nullable": true, "type": "number" }, - "type": "array", - "writeOnly": true + "type": "array" }, "ycoord": { "items": { + "nullable": true, "type": "number" }, "type": "array" @@ -1985,72 +1441,6 @@ ], "type": "object" }, - "ColumnExpression": { - "description": "Single column projection override: applies `function(column)` to a source column.", - "properties": { - "column": { - "description": "Source column produced by parquet schema inference (after columnOverrides).", - "type": "string" - }, - "function": { - "description": "StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.", - "enum": [ - "HLL_HASH", - "BITMAP_HASH", - "BITMAP_HASH64", - "TO_BITMAP" - ], - "type": "string" - } - }, - "required": [ - "column", - "function" - ], - "type": "object" - }, - "ColumnInfo": { - "description": "A single column definition inferred from the parquet schema", - "properties": { - "name": { - "description": "Column name", - "type": "string" - }, - "type": { - "description": "SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE)", - "type": "string" - } - }, - "required": [ - "name", - "type" - ], - "type": "object" - }, - "ColumnPartitionConfig": { - "description": "Partition by column expression.", - "properties": { - "columns": { - "description": "Columns to partition by.", - "items": { - "description": "Columns to partition by.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "column" - ], - "type": "string" - } - }, - "required": [ - "columns", - "type" - ], - "type": "object" - }, "ComparisonCondition": { "description": "Condition that compares the metric value to a given constant value using a comparison operator.", "properties": { @@ -2186,284 +1576,40 @@ ], "type": "object" }, - "CreatePipeTableRequest": { - "description": "Request to create a new pipe-backed OLAP table in the AI Lake", + "DataColumnLocator": { + "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", + "example": { + "dim2": { + "measureGroup": "m1", + "status": "lost" + } + }, "properties": { - "aggregationOverrides": { + "properties": { "additionalProperties": { - "description": "Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.", + "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", + "example": "{\"status\":\"lost\",\"measureGroup\":\"m1\"}", "type": "string" }, - "description": "Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.", - "type": "object" - }, - "columnExpressions": { - "additionalProperties": { - "$ref": "#/components/schemas/ColumnExpression" + "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", + "example": { + "measureGroup": "m1", + "status": "lost" }, - "description": "Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).", "type": "object" - }, - "columnOverrides": { + } + }, + "required": [ + "properties" + ], + "type": "object" + }, + "DataColumnLocators": { + "description": "Data column locators for the values.", + "properties": { + "properties": { "additionalProperties": { - "description": "Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.", - "type": "string" - }, - "description": "Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.", - "type": "object" - }, - "distributionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/HashDistributionConfig" - }, - { - "$ref": "#/components/schemas/RandomDistributionConfig" - } - ] - }, - "keyConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AggregateKeyConfig" - }, - { - "$ref": "#/components/schemas/DuplicateKeyConfig" - }, - { - "$ref": "#/components/schemas/PrimaryKeyConfig" - }, - { - "$ref": "#/components/schemas/UniqueKeyConfig" - } - ] - }, - "maxVarcharLength": { - "description": "Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.", - "format": "int32", - "type": "integer" - }, - "partitionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/ColumnPartitionConfig" - }, - { - "$ref": "#/components/schemas/DateTruncPartitionConfig" - }, - { - "$ref": "#/components/schemas/TimeSlicePartitionConfig" - } - ] - }, - "pathPrefix": { - "description": "Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.", - "type": "string" - }, - "pollingIntervalSeconds": { - "description": "How often (in seconds) the pipe polls for new files. 0 or null = use server default.", - "format": "int32", - "type": "integer" - }, - "sourceStorageName": { - "description": "Name of the pre-configured S3/MinIO ObjectStorage source", - "type": "string" - }, - "tableName": { - "description": "Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$", - "type": "string" - }, - "tableProperties": { - "additionalProperties": { - "description": "CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.", - "type": "string" - }, - "description": "CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.", - "type": "object" - } - }, - "required": [ - "pathPrefix", - "sourceStorageName", - "tableName" - ], - "type": "object" - }, - "CreatedVisualization": { - "description": "List of created visualization objects", - "properties": { - "config": { - "$ref": "#/components/schemas/VisualizationConfig" - }, - "dimensionality": { - "description": "List of attributes representing the dimensionality of the new visualization", - "items": { - "$ref": "#/components/schemas/DimAttribute" - }, - "type": "array" - }, - "filters": { - "description": "List of filters to be applied to the new visualization", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeNegativeFilter" - }, - { - "$ref": "#/components/schemas/AttributePositiveFilter" - }, - { - "$ref": "#/components/schemas/DateAbsoluteFilter" - }, - { - "$ref": "#/components/schemas/DateRelativeFilter" - }, - { - "$ref": "#/components/schemas/GenAiRankingFilter" - } - ] - }, - "type": "array" - }, - "id": { - "description": "Proposed ID of the new visualization", - "example": "revenue_by_country", - "type": "string" - }, - "metrics": { - "description": "List of metrics to be used in the new visualization", - "items": { - "$ref": "#/components/schemas/Metric" - }, - "type": "array" - }, - "savedVisualizationId": { - "description": "Saved visualization ID.", - "type": "string" - }, - "suggestions": { - "description": "Suggestions for next steps", - "items": { - "$ref": "#/components/schemas/Suggestion" - }, - "type": "array" - }, - "title": { - "description": "Proposed title of the new visualization", - "example": "Revenue by Country", - "type": "string" - }, - "visualizationType": { - "description": "Visualization type requested in question", - "enum": [ - "TABLE", - "HEADLINE", - "BAR", - "LINE", - "PIE", - "COLUMN", - "SCATTER" - ], - "example": "TABLE", - "type": "string" - } - }, - "required": [ - "dimensionality", - "filters", - "id", - "metrics", - "suggestions", - "title", - "visualizationType" - ], - "type": "object" - }, - "CreatedVisualizations": { - "description": "Visualization definitions created by AI.", - "properties": { - "objects": { - "description": "List of created visualization objects", - "items": { - "$ref": "#/components/schemas/CreatedVisualization" - }, - "type": "array" - }, - "reasoning": { - "deprecated": true, - "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", - "type": "string" - }, - "suggestions": { - "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", - "items": { - "$ref": "#/components/schemas/Suggestion" - }, - "type": "array" - } - }, - "required": [ - "objects", - "reasoning", - "suggestions" - ], - "type": "object" - }, - "DashboardContext": { - "description": "Dashboard the user is currently viewing.", - "properties": { - "id": { - "description": "Dashboard object ID.", - "type": "string" - }, - "widgets": { - "description": "Widgets currently visible on the dashboard.", - "items": { - "$ref": "#/components/schemas/WidgetDescriptor" - }, - "type": "array" - } - }, - "required": [ - "id", - "widgets" - ], - "type": "object" - }, - "DataColumnLocator": { - "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", - "example": { - "dim2": { - "measureGroup": "m1", - "status": "lost" - } - }, - "properties": { - "properties": { - "additionalProperties": { - "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", - "example": "{\"status\":\"lost\",\"measureGroup\":\"m1\"}", - "type": "string" - }, - "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", - "example": { - "measureGroup": "m1", - "status": "lost" - }, - "type": "object" - } - }, - "required": [ - "properties" - ], - "type": "object" - }, - "DataColumnLocators": { - "description": "Data column locators for the values.", - "properties": { - "properties": { - "additionalProperties": { - "$ref": "#/components/schemas/DataColumnLocator" + "$ref": "#/components/schemas/DataColumnLocator" }, "description": "Mapping from dimensions to data column locators.", "example": { @@ -2536,33 +1682,6 @@ ], "type": "object" }, - "DateAbsoluteFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "from": { - "type": "string" - }, - "to": { - "type": "string" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "from", - "to", - "using" - ], - "type": "object" - }, "DateFilter": { "description": "Abstract filter definition type for dates.", "oneOf": [ @@ -2581,118 +1700,6 @@ ], "type": "object" }, - "DateRelativeFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "from": { - "format": "int32", - "type": "integer" - }, - "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" - }, - "to": { - "format": "int32", - "type": "integer" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "from", - "granularity", - "to", - "using" - ], - "type": "object" - }, - "DateTruncPartitionConfig": { - "description": "Partition by date_trunc() expression.", - "properties": { - "column": { - "description": "Column to partition on.", - "type": "string" - }, - "type": { - "enum": [ - "dateTrunc" - ], - "type": "string" - }, - "unit": { - "description": "Date/time unit for partition granularity", - "enum": [ - "year", - "quarter", - "month", - "week", - "day", - "hour", - "minute", - "second", - "millisecond", - "microsecond" - ], - "type": "string" - } - }, - "required": [ - "column", - "type", - "unit" - ], - "type": "object" - }, "DependsOn": { "allOf": [ { @@ -2709,6 +1716,14 @@ "description": "Specifies on which label the filter depends on.", "type": "string" }, + "type": { + "description": "Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.", + "enum": [ + "label", + "computedAttribute" + ], + "type": "string" + }, "values": { "description": "Specifies values of the label for element filtering.", "items": { @@ -2772,34 +1787,6 @@ ], "type": "object" }, - "DimAttribute": { - "description": "List of attributes representing the dimensionality of the new visualization", - "properties": { - "id": { - "description": "ID of the object", - "example": "country", - "type": "string" - }, - "title": { - "description": "Title of attribute.", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "attribute" - ], - "example": "attribute", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type" - ], - "type": "object" - }, "Dimension": { "description": "Single dimension description.", "properties": { @@ -2849,48 +1836,6 @@ ], "type": "object" }, - "DistributionConfig": { - "description": "Distribution configuration for the OLAP table.", - "discriminator": { - "mapping": { - "hash": "#/components/schemas/HashDistributionConfig", - "random": "#/components/schemas/RandomDistributionConfig" - }, - "propertyName": "type" - }, - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "DuplicateKeyConfig": { - "description": "Duplicate key model — allows duplicate rows for the given key columns.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "duplicate" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "Element": { "description": "List of returned elements.", "properties": { @@ -2983,6 +1928,14 @@ "example": "Europe/Prague", "type": "string" }, + "type": { + "description": "Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.", + "enum": [ + "label", + "computedAttribute" + ], + "type": "string" + }, "validateBy": { "description": "Return only items that are computable on metric.", "items": { @@ -3073,27 +2026,6 @@ ], "type": "object" }, - "ErrorInfo": { - "description": "Structured error, present when the search could not run (e.g. metadata sync in progress). Absent on success.", - "properties": { - "reason": { - "description": "Stable machine-readable error code. Switch on this for localized client messages.", - "example": "METADATA_SYNC_IN_PROGRESS", - "type": "string" - }, - "statusCode": { - "description": "HTTP-like semantic status (e.g. 503 when the workspace is still syncing).", - "example": 503, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "reason", - "statusCode" - ], - "type": "object" - }, "ExecutionLinks": { "description": "Links to the execution result.", "properties": { @@ -3411,8 +2343,35 @@ ], "type": "object" }, - "Filter": { - "description": "List of filters to be applied to the new visualization", + "FileFlowInput": { + "allOf": [ + { + "properties": { + "dataSourceId": { + "description": "Identifier of the GDSTORAGE data source.", + "type": "string" + }, + "table": { + "description": "Name of the table in the data source.", + "type": "string" + }, + "type": { + "description": "Type of the input.", + "enum": [ + "file" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Reads the latest version of a table uploaded to a GDSTORAGE data source.", + "required": [ + "dataSourceId", + "table", + "type" + ], "type": "object" }, "FilterBy": { @@ -3448,64 +2407,340 @@ { "$ref": "#/components/schemas/CompoundMeasureValueFilter" }, - { - "$ref": "#/components/schemas/AbsoluteDateFilter" + { + "$ref": "#/components/schemas/AbsoluteDateFilter" + }, + { + "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + }, + { + "$ref": "#/components/schemas/RelativeDateFilter" + }, + { + "$ref": "#/components/schemas/AllTimeDateFilter" + }, + { + "$ref": "#/components/schemas/NegativeAttributeFilter" + }, + { + "$ref": "#/components/schemas/PositiveAttributeFilter" + }, + { + "$ref": "#/components/schemas/MatchAttributeFilter" + } + ], + "type": "object" + }, + "FilterDefinitionForSimpleMeasure": { + "description": "Abstract filter definition type for simple metric.", + "oneOf": [ + { + "$ref": "#/components/schemas/DateFilter" + }, + { + "$ref": "#/components/schemas/AttributeFilter" + } + ], + "type": "object" + }, + "FlowColumn": { + "description": "A column of a flow result.", + "properties": { + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Metadata of the column, as the operation that produced it gives them.", + "type": "object" + }, + "name": { + "description": "Name of the column.", + "type": "string" + }, + "type": { + "description": "Type of the values in the column.", + "example": "double", + "type": "string" + } + }, + "required": [ + "metadata", + "name", + "type" + ], + "type": "object" + }, + "FlowExecutionResponse": { + "description": "A submitted flow: where to read its result.", + "properties": { + "links": { + "$ref": "#/components/schemas/ExecutionLinks" + } + }, + "required": [ + "links" + ], + "type": "object" + }, + "FlowInput": { + "description": "An input of a flow.", + "oneOf": [ + { + "$ref": "#/components/schemas/FileFlowInput" + }, + { + "$ref": "#/components/schemas/AfmFlowInput" + }, + { + "$ref": "#/components/schemas/SqlFlowInput" + } + ], + "type": "object" + }, + "FlowOperationDescriptor": { + "description": "An operation that a transformation can run.", + "properties": { + "description": { + "description": "What the operation does.", + "type": "string" + }, + "inputs": { + "description": "Inputs of the operation. The first one is the primary input, named data.", + "items": { + "$ref": "#/components/schemas/FlowOperationInput" + }, + "type": "array" + }, + "name": { + "description": "Name of the operation. A transformation gives it as its operation.", + "type": "string" + }, + "output": { + "$ref": "#/components/schemas/FlowOperationOutput" + }, + "parameters": { + "additionalProperties": true, + "description": "JSON Schema of the parameters of the operation.", + "type": "object" + }, + "pure": { + "description": "True when the result depends only on the inputs and the parameters. The result of an impure operation is never reused.", + "type": "boolean" + } + }, + "required": [ + "description", + "inputs", + "name", + "output", + "parameters", + "pure" + ], + "type": "object" + }, + "FlowOperationInput": { + "description": "An input of an operation.", + "properties": { + "description": { + "description": "What the operation expects in the input.", + "type": "string" + }, + "name": { + "description": "Name of the input. A transformation binds it in its inputRefs.", + "type": "string" + } + }, + "required": [ + "description", + "name" + ], + "type": "object" + }, + "FlowOperationOutput": { + "description": "The output of an operation.", + "properties": { + "description": { + "description": "What the operation produces.", + "type": "string" + } + }, + "required": [ + "description" + ], + "type": "object" + }, + "FlowOperations": { + "description": "The operations that the transformations of a flow can run.", + "properties": { + "operations": { + "description": "Available operations.", + "items": { + "$ref": "#/components/schemas/FlowOperationDescriptor" + }, + "type": "array" + } + }, + "required": [ + "operations" + ], + "type": "object" + }, + "FlowRequest": { + "description": "A flow: named inputs and the transformations that run over them.", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "#/components/schemas/FlowInput" + }, + "description": "Inputs of the flow by name. A transformation refers to an input by its name.", + "type": "object" + }, + "transformations": { + "description": "Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input.", + "items": { + "$ref": "#/components/schemas/FlowTransformation" + }, + "type": "array" + } + }, + "required": [ + "inputs" + ], + "type": "object" + }, + "FlowResultMetadata": { + "description": "Description of a flow result.", + "properties": { + "columns": { + "description": "Columns of the result, in order.", + "items": { + "$ref": "#/components/schemas/FlowColumn" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Metadata of the result, as the operations that produced it give them.", + "type": "object" }, - { - "$ref": "#/components/schemas/AbsoluteGranularityDateFilter" + "totalRows": { + "description": "Number of rows in the result.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "columns", + "metadata", + "totalRows" + ], + "type": "object" + }, + "FlowTablePaging": { + "description": "Position of a page in a table result.", + "properties": { + "columnLimit": { + "description": "Maximum number of columns in the page.", + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/schemas/RelativeDateFilter" + "columnOffset": { + "description": "Index of the first column of the page.", + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/schemas/AllTimeDateFilter" + "rowLimit": { + "description": "Maximum number of rows in the page.", + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/schemas/NegativeAttributeFilter" + "rowOffset": { + "description": "Index of the first row of the page.", + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/schemas/PositiveAttributeFilter" + "totalColumns": { + "description": "Number of columns in the result.", + "format": "int32", + "type": "integer" }, - { - "$ref": "#/components/schemas/MatchAttributeFilter" + "totalRows": { + "description": "Number of rows in the result.", + "format": "int64", + "type": "integer" } + }, + "required": [ + "columnLimit", + "columnOffset", + "rowLimit", + "rowOffset", + "totalColumns", + "totalRows" ], "type": "object" }, - "FilterDefinitionForSimpleMeasure": { - "description": "Abstract filter definition type for simple metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/DateFilter" + "FlowTableResult": { + "description": "A page of a table result.", + "properties": { + "columns": { + "description": "Columns of the page, in order.", + "items": { + "$ref": "#/components/schemas/FlowColumn" + }, + "type": "array" }, - { - "$ref": "#/components/schemas/AttributeFilter" + "data": { + "description": "Rows of the page. A row has one value for each column, in the order of the columns.", + "items": { + "items": { + "type": "object" + }, + "type": "array" + }, + "type": "array" + }, + "paging": { + "$ref": "#/components/schemas/FlowTablePaging" } + }, + "required": [ + "columns", + "data", + "paging" ], "type": "object" }, - "ForecastConfig": { - "description": "Forecast configuration.", + "FlowTransformation": { + "description": "One transformation of a flow: an operation that runs over its inputs.", "properties": { - "confidenceLevel": { - "description": "Confidence interval boundary value.", - "format": "float", - "type": "number" + "id": { + "description": "Identifier of the transformation. Give it when a later transformation refers to it. The identifier does not change the result.", + "nullable": true, + "type": "string" }, - "forecastPeriod": { - "description": "Number of future periods that should be forecasted", - "format": "int32", - "type": "integer" + "inputRefs": { + "additionalProperties": { + "type": "string" + }, + "description": "Inputs of the operation by name. Each one refers to a flow input or to an earlier transformation. The primary input is named data. When data is not given, it refers to the previous transformation, or to the only flow input for the first transformation.", + "type": "object" }, - "seasonal": { - "description": "Whether the input data is seasonal", - "type": "boolean" + "operation": { + "description": "Name of the operation, as the operation catalog lists it.", + "example": "survey_weighting", + "type": "string" + }, + "parameters": { + "additionalProperties": true, + "description": "Parameters of the operation. They must match the parameter schema of the operation.", + "type": "object" } }, "required": [ - "confidenceLevel", - "forecastPeriod", - "seasonal" + "operation" ], "type": "object" }, @@ -3583,69 +2818,6 @@ ], "type": "object" }, - "FoundObjects": { - "description": "List of objects found by similarity search and post-processed by LLM.", - "properties": { - "objects": { - "description": "List of objects found with a similarity search.", - "items": { - "$ref": "#/components/schemas/SearchResultObject" - }, - "type": "array" - }, - "reasoning": { - "deprecated": true, - "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", - "type": "string" - } - }, - "required": [ - "objects", - "reasoning" - ], - "type": "object" - }, - "GenAiRankingFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "dimensionality": { - "items": { - "type": "string" - }, - "type": "array" - }, - "measures": { - "items": { - "type": "string" - }, - "type": "array" - }, - "operator": { - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "value": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - } - ], - "required": [ - "measures", - "operator", - "value" - ], - "type": "object" - }, "GenerateDescriptionRequest": { "properties": { "objectId": { @@ -3799,35 +2971,6 @@ ], "type": "object" }, - "HashDistributionConfig": { - "description": "Hash-based distribution across buckets.", - "properties": { - "buckets": { - "description": "Number of hash buckets. Defaults to 1.", - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "columns": { - "description": "Columns to distribute by. Defaults to first column.", - "items": { - "description": "Columns to distribute by. Defaults to first column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "hash" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "HeaderGroup": { "description": "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", "properties": { @@ -3892,47 +3035,6 @@ ], "type": "object" }, - "InsightWidgetDescriptor": { - "description": "Insight widget displaying a visualization.", - "properties": { - "filters": { - "description": "Filters currently applied to the dashboard.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "resultId": { - "description": "Signed result ID for this widget's cached execution result.", - "type": "string" - }, - "title": { - "description": "Widget title as displayed on the dashboard.", - "type": "string" - }, - "visualizationId": { - "description": "Visualization object ID referenced by this insight widget.", - "type": "string" - }, - "widgetId": { - "description": "Widget object ID.", - "type": "string" - }, - "widgetType": { - "enum": [ - "insight" - ], - "type": "string" - } - }, - "required": [ - "title", - "visualizationId", - "widgetId", - "widgetType" - ], - "type": "object" - }, "JsonApiDocumentDatabaseInstance": { "description": "JSON:API-compatible single-resource response envelope", "properties": { @@ -3949,71 +3051,11 @@ ], "type": "object" }, - "JsonApiDocumentPipeTable": { - "description": "JSON:API-compatible single-resource response envelope", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiItemPipeTable" - }, - "links": { - "$ref": "#/components/schemas/JsonApiListLinks" - } - }, - "required": [ - "data", - "links" - ], - "type": "object" - }, - "JsonApiItemDataSourceInfo": { - "description": "A single JSON:API resource item", - "properties": { - "attributes": { - "$ref": "#/components/schemas/DataSourceInfo" - }, - "id": { - "description": "Resource identifier", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiItemDatabaseInstance": { - "description": "A single JSON:API resource item", - "properties": { - "attributes": { - "$ref": "#/components/schemas/DatabaseInstance" - }, - "id": { - "description": "Resource identifier", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiItemObjectStorageInfo": { + "JsonApiItemDataSourceInfo": { "description": "A single JSON:API resource item", "properties": { "attributes": { - "$ref": "#/components/schemas/ObjectStorageInfo" + "$ref": "#/components/schemas/DataSourceInfo" }, "id": { "description": "Resource identifier", @@ -4031,11 +3073,11 @@ ], "type": "object" }, - "JsonApiItemPipeTable": { + "JsonApiItemDatabaseInstance": { "description": "A single JSON:API resource item", "properties": { "attributes": { - "$ref": "#/components/schemas/PipeTable" + "$ref": "#/components/schemas/DatabaseInstance" }, "id": { "description": "Resource identifier", @@ -4053,11 +3095,11 @@ ], "type": "object" }, - "JsonApiItemPipeTableSummary": { + "JsonApiItemObjectStorageInfo": { "description": "A single JSON:API resource item", "properties": { "attributes": { - "$ref": "#/components/schemas/PipeTableSummary" + "$ref": "#/components/schemas/ObjectStorageInfo" }, "id": { "description": "Resource identifier", @@ -4166,29 +3208,6 @@ ], "type": "object" }, - "JsonApiListDocumentPipeTableSummary": { - "description": "JSON:API-compatible list response envelope", - "properties": { - "data": { - "description": "Array of resource items", - "items": { - "$ref": "#/components/schemas/JsonApiItemPipeTableSummary" - }, - "type": "array" - }, - "links": { - "$ref": "#/components/schemas/JsonApiListLinks" - }, - "meta": { - "$ref": "#/components/schemas/JsonApiListMeta" - } - }, - "required": [ - "data", - "links" - ], - "type": "object" - }, "JsonApiListDocumentServiceInfo": { "description": "JSON:API-compatible list response envelope", "properties": { @@ -4272,27 +3291,6 @@ "nullable": true, "type": "object" }, - "KeyConfig": { - "description": "Key configuration for the table data model.", - "discriminator": { - "mapping": { - "aggregate": "#/components/schemas/AggregateKeyConfig", - "duplicate": "#/components/schemas/DuplicateKeyConfig", - "primary": "#/components/schemas/PrimaryKeyConfig", - "unique": "#/components/schemas/UniqueKeyConfig" - }, - "propertyName": "type" - }, - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "KeyDriversDimension": { "properties": { "attribute": { @@ -4733,48 +3731,6 @@ ], "type": "object" }, - "Metric": { - "description": "List of metrics to be used in the new visualization", - "properties": { - "aggFunction": { - "description": "Agg function. Empty if a stored metric is used.", - "enum": [ - "COUNT", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN" - ], - "type": "string" - }, - "id": { - "description": "ID of the object", - "example": "revenue", - "type": "string" - }, - "title": { - "description": "Title of metric.", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "metric", - "fact", - "attribute" - ], - "example": "metric", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type" - ], - "type": "object" - }, "MetricDefinitionOverride": { "description": "(EXPERIMENTAL) Override for a catalog metric definition.", "properties": { @@ -4795,9 +3751,13 @@ "description": "Individual change analysis data item", "properties": { "attributeName": { - "description": "The name of the attribute being analyzed", + "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" @@ -4849,6 +3809,7 @@ }, "required": [ "attributeName", + "attributeRef", "attributeValue", "attributeValuesChangeMean", "attributeValuesChangeStd", @@ -4919,52 +3880,11 @@ ], "type": "object" }, - "ObjectReference": { - "properties": { - "id": { - "description": "Object identifier (e.g. widget ID, metric ID).", - "type": "string" - }, - "type": { - "description": "Type of the referenced object.", - "enum": [ - "WIDGET", - "METRIC", - "ATTRIBUTE", - "DASHBOARD" - ], - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "ObjectReferenceGroup": { - "properties": { - "context": { - "$ref": "#/components/schemas/ObjectReference" - }, - "objects": { - "description": "Objects the user explicitly referenced within this context.", - "items": { - "$ref": "#/components/schemas/ObjectReference" - }, - "type": "array" - } - }, - "required": [ - "objects" - ], - "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. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds.", + "description": "Human-readable name. Pass `storageId` to ProvisionDatabase.storageIds.", "example": "s3-data-lake", "type": "string" }, @@ -5078,15 +3998,12 @@ "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* `create-pipe-table` — Creating a pipe table backed by an S3 data source.\n* `delete-pipe-table` — Deleting a pipe table.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n* `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3).\n", + "description": "Type of the long-running operation.\n* `provision-database` — Provisioning of an AI Lake database.\n* `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` — Running a command in a particular AI Lake service.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n", "enum": [ "provision-database", "deprovision-database", "run-service-command", - "create-pipe-table", - "delete-pipe-table", - "analyze-statistics", - "refresh-partition" + "analyze-statistics" ], "type": "string" }, @@ -5280,26 +4197,6 @@ ], "type": "object" }, - "PartitionConfig": { - "description": "Partition configuration for the table.", - "discriminator": { - "mapping": { - "column": "#/components/schemas/ColumnPartitionConfig", - "dateTrunc": "#/components/schemas/DateTruncPartitionConfig", - "timeSlice": "#/components/schemas/TimeSlicePartitionConfig" - }, - "propertyName": "type" - }, - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "PendingOperation": { "allOf": [ { @@ -5322,143 +4219,6 @@ ], "type": "object" }, - "PipeTable": { - "description": "Full details of a pipe-backed OLAP table", - "properties": { - "columns": { - "description": "Inferred column schema", - "items": { - "$ref": "#/components/schemas/ColumnInfo" - }, - "type": "array" - }, - "databaseName": { - "description": "Database name", - "type": "string" - }, - "distributionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/HashDistributionConfig" - }, - { - "$ref": "#/components/schemas/RandomDistributionConfig" - } - ] - }, - "keyConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AggregateKeyConfig" - }, - { - "$ref": "#/components/schemas/DuplicateKeyConfig" - }, - { - "$ref": "#/components/schemas/PrimaryKeyConfig" - }, - { - "$ref": "#/components/schemas/UniqueKeyConfig" - } - ] - }, - "partitionColumns": { - "description": "Hive partition columns detected from the path structure", - "items": { - "description": "Hive partition columns detected from the path structure", - "type": "string" - }, - "type": "array" - }, - "partitionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/ColumnPartitionConfig" - }, - { - "$ref": "#/components/schemas/DateTruncPartitionConfig" - }, - { - "$ref": "#/components/schemas/TimeSlicePartitionConfig" - } - ] - }, - "pathPrefix": { - "description": "Path prefix to the parquet files", - "type": "string" - }, - "pipeTableId": { - "description": "Internal UUID of the pipe table record", - "type": "string" - }, - "pollingIntervalSeconds": { - "description": "How often (in seconds) the pipe polls for new files. 0 = server default.", - "format": "int32", - "type": "integer" - }, - "sourceStorageName": { - "description": "Source ObjectStorage name", - "type": "string" - }, - "tableName": { - "description": "OLAP table name", - "type": "string" - }, - "tableProperties": { - "additionalProperties": { - "description": "CREATE TABLE PROPERTIES key-value pairs", - "type": "string" - }, - "description": "CREATE TABLE PROPERTIES key-value pairs", - "type": "object" - } - }, - "required": [ - "columns", - "databaseName", - "distributionConfig", - "keyConfig", - "partitionColumns", - "pathPrefix", - "pipeTableId", - "pollingIntervalSeconds", - "sourceStorageName", - "tableName", - "tableProperties" - ], - "type": "object" - }, - "PipeTableSummary": { - "description": "Lightweight pipe table entry used in list responses", - "properties": { - "columns": { - "description": "Inferred column schema", - "items": { - "$ref": "#/components/schemas/ColumnInfo" - }, - "type": "array" - }, - "pathPrefix": { - "description": "Path prefix to the parquet files", - "type": "string" - }, - "pipeTableId": { - "description": "Internal UUID of the pipe table record", - "type": "string" - }, - "tableName": { - "description": "OLAP table name", - "type": "string" - } - }, - "required": [ - "columns", - "pathPrefix", - "pipeTableId", - "tableName" - ], - "type": "object" - }, "PopDataset": { "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", "properties": { @@ -5598,29 +4358,6 @@ ], "type": "object" }, - "PrimaryKeyConfig": { - "description": "Primary key model — enforces uniqueness, replaces on conflict.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "primary" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "ProvisionDatabaseInstanceRequest": { "description": "Request to provision a new AILake Database instance", "properties": { @@ -5761,27 +4498,6 @@ ], "type": "object" }, - "RandomDistributionConfig": { - "description": "Random distribution across buckets.", - "properties": { - "buckets": { - "description": "Number of random distribution buckets. Defaults to 1.", - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "type": { - "enum": [ - "random" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "RangeCondition": { "description": "Condition that checks if the metric value is within a given range.", "properties": { @@ -5931,64 +4647,6 @@ ], "type": "object" }, - "Reasoning": { - "description": "Reasoning wrapper containing steps taken during request handling.", - "properties": { - "answer": { - "description": "Final answer/reasoning from the use case result.", - "type": "string" - }, - "steps": { - "description": "Steps taken during processing, showing the AI's reasoning process.", - "items": { - "$ref": "#/components/schemas/ReasoningStep" - }, - "type": "array" - } - }, - "required": [ - "steps" - ], - "type": "object" - }, - "ReasoningStep": { - "description": "Steps taken during processing, showing the AI's reasoning process.", - "properties": { - "thoughts": { - "description": "Detailed thoughts/messages within this step.", - "items": { - "$ref": "#/components/schemas/Thought" - }, - "type": "array" - }, - "title": { - "description": "Title describing this reasoning step.", - "type": "string" - } - }, - "required": [ - "thoughts", - "title" - ], - "type": "object" - }, - "RefreshPartitionRequest": { - "description": "Request to refresh a specific Hive partition in a pipe-backed OLAP table", - "properties": { - "partitionSpec": { - "additionalProperties": { - "description": "Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"}", - "type": "string" - }, - "description": "Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"}", - "type": "object" - } - }, - "required": [ - "partitionSpec" - ], - "type": "object" - }, "RelativeDateFilter": { "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", "properties": { @@ -6103,68 +4761,6 @@ ], "type": "object" }, - "ResolvedLlm": { - "description": "The resolved LLM configuration, or null if none is configured.", - "properties": { - "id": { - "type": "string" - }, - "title": { - "type": "string" - } - }, - "required": [ - "id", - "title" - ], - "type": "object" - }, - "ResolvedLlmProvider": { - "allOf": [ - { - "$ref": "#/components/schemas/ResolvedLlm" - }, - { - "properties": { - "id": { - "description": "Provider Id", - "type": "string" - }, - "models": { - "items": { - "$ref": "#/components/schemas/LlmModel" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "title": { - "description": "Provider Title", - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "id", - "models", - "title" - ], - "type": "object" - }, - "ResolvedLlms": { - "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/ResolvedLlmProvider" - } - ] - } - }, - "type": "object" - }, "RestApiIdentifier": { "description": "Object identifier.", "properties": { @@ -6262,70 +4858,6 @@ ], "type": "object" }, - "RichTextWidgetDescriptor": { - "description": "Rich text widget displaying static content. Has no execution result.", - "properties": { - "content": { - "description": "Markdown/text content of the rich text widget.", - "type": "string" - }, - "filters": { - "description": "Filters currently applied to the dashboard.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "title": { - "description": "Widget title as displayed on the dashboard.", - "type": "string" - }, - "widgetId": { - "description": "Widget object ID.", - "type": "string" - }, - "widgetType": { - "enum": [ - "richText" - ], - "type": "string" - } - }, - "required": [ - "title", - "widgetId", - "widgetType" - ], - "type": "object" - }, - "RouteResult": { - "description": "Question -> Use Case routing. May contain final answer is a special use case is not required.", - "properties": { - "reasoning": { - "description": "Explanation why LLM picked this use case.", - "type": "string" - }, - "useCase": { - "description": "Use case where LLM routed based on question.", - "enum": [ - "INVALID", - "GENERAL", - "SEARCH", - "CREATE_VISUALIZATION", - "EXTEND_VISUALIZATION", - "HOWTO", - "CHANGE_ANALYSIS", - "ALERT" - ], - "type": "string" - } - }, - "required": [ - "reasoning", - "useCase" - ], - "type": "object" - }, "RunServiceCommandRequest": { "description": "Request to run an AI Lake Service Command", "properties": { @@ -6342,272 +4874,7 @@ "payload": { "$ref": "#/components/schemas/JsonNode" } - }, - "type": "object" - }, - "SavedVisualization": { - "description": "Created and saved visualization IDs.", - "properties": { - "createdVisualizationId": { - "description": "Created visualization ID.", - "type": "string" - }, - "savedVisualizationId": { - "description": "Saved visualization ID.", - "type": "string" - } - }, - "required": [ - "createdVisualizationId", - "savedVisualizationId" - ], - "type": "object" - }, - "SearchRelationshipObject": { - "properties": { - "sourceObjectId": { - "description": "Source object ID.", - "type": "string" - }, - "sourceObjectTitle": { - "description": "Source object title.", - "type": "string" - }, - "sourceObjectType": { - "description": "Source object type, e.g. dashboard.", - "type": "string" - }, - "sourceWorkspaceId": { - "description": "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.", - "type": "string" - }, - "targetObjectId": { - "description": "Target object ID.", - "type": "string" - }, - "targetObjectTitle": { - "description": "Target object title.", - "type": "string" - }, - "targetObjectType": { - "description": "Target object type, e.g. visualization.", - "type": "string" - }, - "targetWorkspaceId": { - "description": "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.", - "type": "string" - } - }, - "required": [ - "sourceObjectId", - "sourceObjectTitle", - "sourceObjectType", - "sourceWorkspaceId", - "targetObjectId", - "targetObjectTitle", - "targetObjectType", - "targetWorkspaceId" - ], - "type": "object" - }, - "SearchRequest": { - "properties": { - "allowedRelationshipTypes": { - "description": "Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.", - "items": { - "$ref": "#/components/schemas/AllowedRelationshipType" - }, - "type": "array" - }, - "deepSearch": { - "default": false, - "description": "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.", - "type": "boolean" - }, - "enableHybridSearch": { - "default": false, - "description": "If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.", - "type": "boolean" - }, - "excludeTags": { - "description": "Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.", - "items": { - "description": "Tag to exclude.", - "type": "string" - }, - "type": "array" - }, - "includeHidden": { - "default": false, - "description": "If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.", - "type": "boolean" - }, - "includeTags": { - "description": "Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.", - "items": { - "description": "Tag to include.", - "type": "string" - }, - "type": "array" - }, - "limit": { - "default": 10, - "description": "Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.", - "format": "int32", - "type": "integer" - }, - "objectTypes": { - "description": "List of object types to search for.", - "items": { - "description": "Object type to search for.", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "type": "array" - }, - "question": { - "description": "Keyword/sentence is input for search.", - "maxLength": 1000, - "type": "string" - }, - "relevantScoreThreshold": { - "default": 0.3, - "description": "Score, above which we return found objects. Below this score objects are not relevant.", - "format": "double", - "type": "number" - }, - "titleToDescriptorRatio": { - "default": 0.7, - "description": "Temporary for experiments. Ratio of title score to descriptor score.", - "format": "double", - "type": "number" - } - }, - "required": [ - "question" - ], - "type": "object" - }, - "SearchResult": { - "properties": { - "error": { - "$ref": "#/components/schemas/ErrorInfo" - }, - "reasoning": { - "deprecated": true, - "description": "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", - "type": "string" - }, - "relationships": { - "items": { - "$ref": "#/components/schemas/SearchRelationshipObject" - }, - "type": "array" - }, - "results": { - "items": { - "$ref": "#/components/schemas/SearchResultObject" - }, - "type": "array" - } - }, - "required": [ - "reasoning", - "relationships", - "results" - ], - "type": "object" - }, - "SearchResultObject": { - "properties": { - "certification": { - "$ref": "#/components/schemas/CertificationInfo" - }, - "createdAt": { - "description": "Timestamp when object was created.", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Object description.", - "type": "string" - }, - "id": { - "description": "Object ID.", - "type": "string" - }, - "isHidden": { - "description": "If true, this object is hidden from AI search results by default.", - "type": "boolean" - }, - "modifiedAt": { - "description": "Timestamp when object was last modified.", - "format": "date-time", - "type": "string" - }, - "score": { - "description": "Result score calculated by a similarity search algorithm (cosine_distance).", - "format": "float", - "type": "number" - }, - "scoreDescriptor": { - "description": "Result score for descriptor containing(now) description and tags.", - "format": "float", - "type": "number" - }, - "scoreExactMatch": { - "description": "Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.", - "format": "int32", - "type": "integer" - }, - "scoreTitle": { - "description": "Result score for object title.", - "format": "float", - "type": "number" - }, - "tags": { - "items": { - "description": "List of tags assigned to the object.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "title": { - "description": "Object title.", - "type": "string" - }, - "type": { - "description": "Object type, e.g. dashboard.", - "type": "string" - }, - "visualizationUrl": { - "description": "If the object is visualization, this field defines the type of visualization.", - "type": "string" - }, - "workspaceId": { - "description": "Workspace ID.", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type", - "workspaceId" - ], - "type": "object" - }, - "ServerSentEventChatResult": { + }, "type": "object" }, "ServiceInfo": { @@ -6802,6 +5069,38 @@ ], "type": "object" }, + "SqlFlowInput": { + "allOf": [ + { + "properties": { + "dataSourceId": { + "description": "Identifier of the data source that runs the statement.", + "type": "string" + }, + "sql": { + "description": "One SELECT statement in the SQL dialect of the data source.", + "example": "SELECT region, SUM(amount) AS amount FROM sales GROUP BY region", + "type": "string" + }, + "type": { + "description": "Type of the input.", + "enum": [ + "sql" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Runs a SELECT statement on a data source and reads its rows as a table. Its columns are named and typed as the statement returns them. Data filters of the workspace and of the user do not apply. A GDSTORAGE, FlexConnect or platform-managed data source cannot run it.", + "required": [ + "dataSourceId", + "sql", + "type" + ], + "type": "object" + }, "SucceededOperation": { "allOf": [ { @@ -6833,24 +5132,6 @@ ], "type": "object" }, - "Suggestion": { - "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", - "properties": { - "label": { - "description": "Suggestion button label", - "type": "string" - }, - "query": { - "description": "Suggestion query", - "type": "string" - } - }, - "required": [ - "label", - "query" - ], - "type": "object" - }, "TestLlmProviderByIdRequest": { "properties": { "models": { @@ -6909,63 +5190,6 @@ ], "type": "object" }, - "Thought": { - "description": "Detailed thoughts/messages within this step.", - "properties": { - "text": { - "description": "The text content of this thought.", - "type": "string" - } - }, - "required": [ - "text" - ], - "type": "object" - }, - "TimeSlicePartitionConfig": { - "description": "Partition by time_slice() expression.", - "properties": { - "column": { - "description": "Column to partition on.", - "type": "string" - }, - "slices": { - "description": "How many units per slice.", - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "type": { - "enum": [ - "timeSlice" - ], - "type": "string" - }, - "unit": { - "description": "Date/time unit for partition granularity", - "enum": [ - "year", - "quarter", - "month", - "week", - "day", - "hour", - "minute", - "second", - "millisecond", - "microsecond" - ], - "type": "string" - } - }, - "required": [ - "column", - "slices", - "type", - "unit" - ], - "type": "object" - }, "Total": { "description": "Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension`", "properties": { @@ -7186,368 +5410,78 @@ ], "type": "object" }, - "UIContext": { - "description": "Ambient UI state: what the user is currently looking at (dashboard, visible widgets).", - "properties": { - "dashboard": { - "$ref": "#/components/schemas/DashboardContext" - } - }, - "type": "object" - }, - "UniqueKeyConfig": { - "description": "Unique key model — enforces uniqueness, replaces on conflict.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "unique" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "UpdateDatabaseDataSourceRequest": { "description": "Request to update the data source associated with an AI Lake Database instance", "properties": { "dataSourceId": { - "description": "New identifier for the data source in metadata-api. Must be unique within the organization.", - "type": "string" - }, - "dataSourceName": { - "description": "New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.", - "type": "string" - }, - "oldDataSourceId": { - "description": "Identifier of the existing data source to replace.", - "type": "string" - } - }, - "required": [ - "dataSourceId", - "oldDataSourceId" - ], - "type": "object" - }, - "UpdateDatabaseDataSourceResponse": { - "description": "Updated data source details for an AI Lake Database instance", - "properties": { - "dataSourceId": { - "description": "New identifier of the data source in metadata-api.", - "type": "string" - }, - "dataSourceName": { - "description": "New display name of the data source in metadata-api.", - "type": "string" - } - }, - "required": [ - "dataSourceId", - "dataSourceName" - ], - "type": "object" - }, - "UserContext": { - "description": "User context with ambient UI state (view) and explicitly referenced objects.", - "properties": { - "activeObject": { - "$ref": "#/components/schemas/ActiveObjectIdentification" - }, - "referencedObjects": { - "description": "Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).", - "items": { - "$ref": "#/components/schemas/ObjectReferenceGroup" - }, - "type": "array" - }, - "view": { - "$ref": "#/components/schemas/UIContext" - } - }, - "type": "object" - }, - "ValidateByItem": { - "nullable": true, - "properties": { - "id": { - "description": "Specifies entity used for valid elements computation.", - "type": "string" - }, - "type": { - "description": "Specifies entity type which could be label, attribute, fact, or metric.", - "pattern": "^(label)|(attribute)|(fact)|(metric)$", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "VisualizationConfig": { - "description": "Visualization config for smart-function rendering.", - "properties": { - "anomalyDetection": { - "$ref": "#/components/schemas/AnomalyDetectionConfig" - }, - "clustering": { - "$ref": "#/components/schemas/ClusteringConfig" - }, - "forecast": { - "$ref": "#/components/schemas/ForecastConfig" - }, - "whatIf": { - "$ref": "#/components/schemas/WhatIfScenarioConfig" - } - }, - "type": "object" - }, - "VisualizationObjectExecution": { - "properties": { - "filters": { - "description": "Additional AFM filters merged on top of the visualization object's own filters.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "settings": { - "$ref": "#/components/schemas/ExecutionSettings" - } - }, - "type": "object" - }, - "VisualizationSwitcherWidgetDescriptor": { - "description": "Visualization switcher widget allowing users to toggle between multiple visualizations.", - "properties": { - "activeVisualizationId": { - "description": "ID of the currently active visualization in the switcher.", - "type": "string" - }, - "filters": { - "description": "Filters currently applied to the dashboard.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "resultId": { - "description": "Signed result ID for the currently active visualization's execution result.", - "type": "string" - }, - "title": { - "description": "Widget title as displayed on the dashboard.", - "type": "string" - }, - "visualizationIds": { - "description": "IDs of all visualizations available in the switcher.", - "items": { - "type": "string" - }, - "type": "array" - }, - "widgetId": { - "description": "Widget object ID.", - "type": "string" - }, - "widgetType": { - "enum": [ - "visualizationSwitcher" - ], - "type": "string" - } - }, - "required": [ - "activeVisualizationId", - "title", - "visualizationIds", - "widgetId", - "widgetType" - ], - "type": "object" - }, - "WhatIfMeasureAdjustmentConfig": { - "description": "Measure adjustments for this scenario", - "properties": { - "metricId": { - "description": "ID of the metric or fact to adjust", - "type": "string" - }, - "metricType": { - "description": "Type: metric or fact", - "type": "string" - }, - "scenarioMaql": { - "description": "Alternative MAQL expression for this scenario", - "type": "string" - } - }, - "required": [ - "metricId", - "metricType", - "scenarioMaql" - ], - "type": "object" - }, - "WhatIfScenarioConfig": { - "description": "What-if scenario configuration.", - "properties": { - "includeBaseline": { - "description": "Whether baseline (unmodified) values are included", - "type": "boolean" - }, - "scenarios": { - "description": "Scenarios with alternative measure calculations", - "items": { - "$ref": "#/components/schemas/WhatIfScenarioItem" - }, - "type": "array" - } - }, - "required": [ - "includeBaseline", - "scenarios" - ], - "type": "object" - }, - "WhatIfScenarioItem": { - "description": "Scenarios with alternative measure calculations", - "properties": { - "adjustments": { - "description": "Measure adjustments for this scenario", - "items": { - "$ref": "#/components/schemas/WhatIfMeasureAdjustmentConfig" - }, - "type": "array" - }, - "label": { - "description": "Human-readable scenario label", - "type": "string" - } - }, - "required": [ - "adjustments", - "label" - ], - "type": "object" - }, - "WidgetDescriptor": { - "description": "Descriptor for a widget on the dashboard.", - "discriminator": { - "mapping": { - "insight": "#/components/schemas/InsightWidgetDescriptor", - "richText": "#/components/schemas/RichTextWidgetDescriptor", - "visualizationSwitcher": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" - }, - "propertyName": "widgetType" - }, - "properties": { - "filters": { - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "title": { + "description": "New identifier for the data source in metadata-api. Must be unique within the organization.", "type": "string" }, - "widgetId": { + "dataSourceName": { + "description": "New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.", "type": "string" }, - "widgetType": { + "oldDataSourceId": { + "description": "Identifier of the existing data source to replace.", "type": "string" } }, "required": [ - "title", - "widgetId", - "widgetType" + "dataSourceId", + "oldDataSourceId" ], "type": "object" }, - "WorkflowDashboardSummaryRequestDto": { + "UpdateDatabaseDataSourceResponse": { + "description": "Updated data source details for an AI Lake Database instance", "properties": { - "customUserPrompt": { - "type": "string" - }, - "dashboardId": { + "dataSourceId": { + "description": "New identifier of the data source in metadata-api.", "type": "string" }, - "keyMetricIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "referenceQuarter": { + "dataSourceName": { + "description": "New display name of the data source in metadata-api.", "type": "string" } }, "required": [ - "dashboardId" + "dataSourceId", + "dataSourceName" ], "type": "object" }, - "WorkflowDashboardSummaryResponseDto": { + "ValidateByItem": { + "nullable": true, "properties": { - "message": { - "type": "string" - }, - "runId": { + "id": { + "description": "Specifies entity used for valid elements computation.", "type": "string" }, - "status": { + "type": { + "description": "Specifies entity type which could be label, attribute, computedAttribute, fact, or metric.", + "pattern": "^(label|attribute|computedAttribute|fact|metric)$", "type": "string" } }, "required": [ - "message", - "runId", - "status" + "id", + "type" ], "type": "object" }, - "WorkflowStatusResponseDto": { + "VisualizationObjectExecution": { "properties": { - "currentPhase": { - "type": "string" - }, - "error": { - "type": "string" - }, - "message": { - "type": "string" - }, - "result": { - "additionalProperties": { - "type": "object" + "filters": { + "description": "Additional AFM filters merged on top of the visualization object's own filters.", + "items": { + "$ref": "#/components/schemas/FilterDefinition" }, - "type": "object" - }, - "runId": { - "type": "string" + "type": "array" }, - "status": { - "type": "string" + "settings": { + "$ref": "#/components/schemas/ExecutionSettings" } }, - "required": [ - "message", - "runId", - "status" - ], "type": "object" } } @@ -7872,7 +5806,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", + "deprecated": true, + "description": "Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead.", "operationId": "aiChat", "parameters": [ { @@ -7888,27 +5823,16 @@ ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatRequest" - } - } + "application/json": {} }, - "required": true + "description": "Ignored. Kept optional so callers still on the old client are not rejected before reaching this endpoint." }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatResult" - } - } - }, - "description": "OK" + "410": { + "description": "Gone" } }, - "summary": "(BETA) Chat with AI", + "summary": "(REMOVED) Chat with AI", "tags": [ "Smart Functions", "actions" @@ -7917,7 +5841,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { "post": { - "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", + "deprecated": true, + "description": "Removed. Chat history is served by the AI Assistant API.", "operationId": "aiChatHistory", "parameters": [ { @@ -7933,27 +5858,16 @@ ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatHistoryRequest" - } - } + "application/json": {} }, - "required": true + "description": "Ignored. Kept optional so callers still on the old client are not rejected before reaching this endpoint." }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatHistoryResult" - } - } - }, - "description": "OK" + "410": { + "description": "Gone" } }, - "summary": "(BETA) Get Chat History", + "summary": "(REMOVED) Get Chat History", "tags": [ "Smart Functions", "actions" @@ -7962,7 +5876,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", + "deprecated": true, + "description": "Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead.", "operationId": "aiChatStream", "parameters": [ { @@ -7978,30 +5893,16 @@ ], "requestBody": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatRequest" - } - } + "application/json": {} }, - "required": true + "description": "Ignored. Kept optional so callers still on the old client are not rejected before reaching this endpoint." }, "responses": { - "200": { - "content": { - "text/event-stream": { - "schema": { - "items": { - "$ref": "#/components/schemas/ServerSentEventChatResult" - }, - "type": "array" - } - } - }, - "description": "OK" + "410": { + "description": "Gone" } }, - "summary": "(BETA) Chat with AI", + "summary": "(REMOVED) Chat with AI", "tags": [ "Smart Functions", "actions" @@ -8010,7 +5911,8 @@ }, "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { "get": { - "description": "Returns usage statistics of chat for a user in a workspace.", + "deprecated": true, + "description": "Removed. Chat usage is served by the AI Assistant API.", "operationId": "aiChatUsage", "parameters": [ { @@ -8025,18 +5927,11 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ChatUsageResponse" - } - } - }, - "description": "OK" + "410": { + "description": "Gone" } }, - "summary": "Get Chat Usage", + "summary": "(REMOVED) Get Chat Usage", "tags": [ "Smart Functions", "actions" @@ -8221,10 +6116,61 @@ ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders": { - "get": { - "description": "Resolves the active LLM provider configuration for the given workspace.", - "operationId": "resolveLlmProviders", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { + "post": { + "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", + "operationId": "cancelExecutions", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "description": "Status of the cancellation operation." + } + }, + "summary": "Applies all the given cancel tokens.", + "tags": [ + "Computation", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { + "post": { + "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", + "operationId": "computeValidDescendants", "parameters": [ { "description": "Workspace identifier", @@ -8237,29 +6183,45 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmValidDescendantsQuery" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResolvedLlms" + "$ref": "#/components/schemas/AfmValidDescendantsResponse" } } }, - "description": "OK" + "description": "Map of lists of attributes valid as descendants of the given attributes." } }, - "summary": "Get Active LLM configuration for this workspace", + "summary": "(BETA) Valid descendants", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to analyze data.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/search": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects": { "post": { - "description": "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.", - "operationId": "aiSearch", + "description": "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", + "operationId": "computeValidObjects", "parameters": [ { "description": "Workspace identifier", @@ -8276,7 +6238,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchRequest" + "$ref": "#/components/schemas/AfmValidObjectsQuery" } } }, @@ -8287,23 +6249,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchResult" + "$ref": "#/components/schemas/AfmValidObjectsResponse" } } }, - "description": "OK" + "description": "List of attributes, facts and metrics valid with respect to given AFM." } }, - "summary": "(BETA) Semantic Search in Metadata", + "summary": "Valid objects", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view data.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute": { "post": { - "operationId": "generateDashboardSummary", + "description": "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", + "operationId": "computeReport", "parameters": [ { "description": "Workspace identifier", @@ -8314,13 +6283,35 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "deprecated": true, + "example": "2020-06-03T10:15:30+01:00", + "in": "header", + "name": "timestamp", + "required": false, + "schema": { + "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", + "format": "timestamp", + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkflowDashboardSummaryRequestDto" + "$ref": "#/components/schemas/AfmExecution" } } }, @@ -8331,21 +6322,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkflowDashboardSummaryResponseDto" + "$ref": "#/components/schemas/AfmExecutionResponse" } } }, - "description": "OK" + "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "A token that can be used to cancel this execution", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, + "summary": "Executes analytical request and returns link to the result", "tags": [ + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/cancel": { - "post": { - "operationId": "cancelWorkflow", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { + "get": { + "description": "Gets a single execution result.", + "operationId": "retrieveResult", "parameters": [ { "description": "Workspace identifier", @@ -8358,12 +6367,72 @@ } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "runId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", + "example": "offset=1,10", + "explode": false, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": [], + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", + "example": "limit=1,10", + "explode": false, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": [], + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.", + "example": "excludedTotalDimensions=dim_0,dim_1", + "explode": false, + "in": "query", + "name": "excludedTotalDimensions", + "required": false, + "schema": { + "default": [], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -8371,24 +6440,30 @@ "content": { "application/json": { "schema": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "$ref": "#/components/schemas/ExecutionResult" } } }, - "description": "OK" + "description": "Execution result was found and returned." } }, + "summary": "Get a single execution result", "tags": [ + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/status": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary": { "get": { - "operationId": "getWorkflowStatus", + "description": "(BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.", + "operationId": "retrieveResultBinary", "parameters": [ { "description": "Workspace identifier", @@ -8401,35 +6476,70 @@ } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "runId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { "content": { - "application/json": { + "application/vnd.apache.arrow.file": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { "schema": { - "$ref": "#/components/schemas/WorkflowStatusResponseDto" + "format": "binary", + "type": "string" } } }, - "description": "OK" + "description": "Execution result was found and returned.", + "headers": { + "X-GDC-RESULT-TOTAL-ROWS": { + "description": "Total number of data rows in the full result.", + "schema": { + "format": "int64", + "type": "integer" + }, + "style": "simple" + } + } } }, + "summary": "(BETA) Get a single execution result in Apache Arrow File or Stream format", "tags": [ + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { - "post": { - "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", - "operationId": "cancelExecutions", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": { + "get": { + "description": "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", + "operationId": "retrieveExecutionMetadata", "parameters": [ { "description": "Workspace identifier", @@ -8440,47 +6550,47 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in": "path", + "name": "resultId", + "required": true, + "schema": { + "type": "string" + } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmCancelTokens" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmCancelTokens" + "$ref": "#/components/schemas/ResultCacheMetadata" } } }, - "description": "Status of the cancellation operation." + "description": "Execution result's metadata was found and returned." } }, - "summary": "Applies all the given cancel tokens.", + "summary": "Get a single execution result's metadata.", "tags": [ "Computation", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", + "description": "Permissions required to analyze data.", "permissions": [ - "VIEW" + "ANALYZE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain": { "post": { - "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", - "operationId": "computeValidDescendants", + "description": "The resource provides static structures needed for investigation of a problem with given AFM.", + "operationId": "explainAFM", "parameters": [ { "description": "Workspace identifier", @@ -8491,13 +6601,37 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request\n\n`GIT` - Git properties of current build", + "in": "query", + "name": "explainType", + "required": false, + "schema": { + "enum": [ + "MAQL", + "GRPC_MODEL", + "GRPC_MODEL_SVG", + "WDF", + "QT", + "QT_SVG", + "OPT_QT", + "OPT_QT_SVG", + "SQL", + "SETTINGS", + "COMPRESSED_SQL", + "COMPRESSED_GRPC_MODEL_SVG", + "GIT" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmValidDescendantsQuery" + "$ref": "#/components/schemas/AfmExecution" } } }, @@ -8506,16 +6640,21 @@ "responses": { "200": { "content": { - "application/json": { + "application/json": {}, + "application/sql": {}, + "application/zip": { "schema": { - "$ref": "#/components/schemas/AfmValidDescendantsResponse" + "description": "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", + "format": "binary", + "type": "string" } - } + }, + "image/svg+xml": {} }, - "description": "Map of lists of attributes valid as descendants of the given attributes." + "description": "Requested resource" } }, - "summary": "(BETA) Valid descendants", + "summary": "AFM explain resource.", "tags": [ "Computation", "actions" @@ -8528,10 +6667,10 @@ } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects": { + "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": { "post": { - "description": "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", - "operationId": "computeValidObjects", + "description": "Returns paged list of elements (values) of given label satisfying given filtering criteria.", + "operationId": "computeLabelElementsPost", "parameters": [ { "description": "Workspace identifier", @@ -8539,8 +6678,44 @@ "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "description": "Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "maximum": 10000, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 1000, + "format": "int32", + "maximum": 10000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" } } ], @@ -8548,7 +6723,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmValidObjectsQuery" + "$ref": "#/components/schemas/ElementsRequest" } } }, @@ -8559,30 +6734,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmValidObjectsResponse" + "$ref": "#/components/schemas/ElementsResponse" } } }, - "description": "List of attributes, facts and metrics valid with respect to given AFM." + "description": "List of label values." } }, - "summary": "Valid objects", + "summary": "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", "tags": [ "Computation", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view data.", + "description": "Permissions required to view a report or label elements.", "permissions": [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute": { + "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis": { "post": { - "description": "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", - "operationId": "computeReport", + "description": "Computes change analysis for the provided execution definition.", + "operationId": "changeAnalysis", "parameters": [ { "description": "Workspace identifier", @@ -8593,35 +6768,13 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "deprecated": true, - "example": "2020-06-03T10:15:30+01:00", - "in": "header", - "name": "timestamp", - "required": false, - "schema": { - "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", - "format": "timestamp", - "type": "string" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmExecution" + "$ref": "#/components/schemas/ChangeAnalysisRequest" } } }, @@ -8632,39 +6785,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmExecutionResponse" + "$ref": "#/components/schemas/ChangeAnalysisResponse" } } }, - "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", - "headers": { - "X-GDC-CANCEL-TOKEN": { - "description": "A token that can be used to cancel this execution", - "schema": { - "type": "string" - }, - "style": "simple" - } - } + "description": "OK" } }, - "summary": "Executes analytical request and returns link to the result", + "summary": "Compute change analysis", "tags": [ "Computation", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}": { "get": { - "description": "Gets a single execution result.", - "operationId": "retrieveResult", + "description": "Gets change analysis result.", + "operationId": "changeAnalysisResult", "parameters": [ { "description": "Workspace identifier", @@ -8685,64 +6823,6 @@ "schema": { "type": "string" } - }, - { - "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", - "example": "offset=1,10", - "explode": false, - "in": "query", - "name": "offset", - "required": false, - "schema": { - "default": [], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", - "example": "limit=1,10", - "explode": false, - "in": "query", - "name": "limit", - "required": false, - "schema": { - "default": [], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.", - "example": "excludedTotalDimensions=dim_0,dim_1", - "explode": false, - "in": "query", - "name": "excludedTotalDimensions", - "required": false, - "schema": { - "default": [], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-CANCEL-TOKEN", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -8750,30 +6830,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExecutionResult" + "$ref": "#/components/schemas/ChangeAnalysisResult" } } }, - "description": "Execution result was found and returned." + "description": "OK" } }, - "summary": "Get a single execution result", + "summary": "Get change analysis result", "tags": [ "Computation", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary": { - "get": { - "description": "(BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.", - "operationId": "retrieveResultBinary", + "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { + "post": { + "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", + "operationId": "keyDriverAnalysis", "parameters": [ { "description": "Workspace identifier", @@ -8786,70 +6860,49 @@ } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } - }, - { + "description": "Ignore all caches during execution of current request.", "in": "header", - "name": "X-GDC-CANCEL-TOKEN", + "name": "skip-cache", "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeyDriversRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { - "application/vnd.apache.arrow.file": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.apache.arrow.stream": { + "application/json": { "schema": { - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/KeyDriversResponse" } } }, - "description": "Execution result was found and returned.", - "headers": { - "X-GDC-RESULT-TOTAL-ROWS": { - "description": "Total number of data rows in the full result.", - "schema": { - "format": "int64", - "type": "integer" - }, - "style": "simple" - } - } + "description": "OK" } }, - "summary": "(BETA) Get a single execution result in Apache Arrow File or Stream format", + "summary": "(EXPERIMENTAL) Compute key driver analysis", "tags": [ "Computation", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": { + "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { "get": { - "description": "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", - "operationId": "retrieveExecutionMetadata", + "description": "(EXPERIMENTAL) Gets key driver analysis.", + "operationId": "keyDriverAnalysisResult", "parameters": [ { "description": "Workspace identifier", @@ -8870,6 +6923,24 @@ "schema": { "type": "string" } + }, + { + "in": "query", + "name": "offset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } } ], "responses": { @@ -8877,30 +6948,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResultCacheMetadata" + "$ref": "#/components/schemas/KeyDriversResult" } } }, - "description": "Execution result's metadata was found and returned." + "description": "OK" } }, - "summary": "Get a single execution result's metadata.", + "summary": "(EXPERIMENTAL) Get key driver analysis result", "tags": [ "Computation", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to analyze data.", - "permissions": [ - "ANALYZE" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain": { + "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers": { "post": { - "description": "The resource provides static structures needed for investigation of a problem with given AFM.", - "operationId": "explainAFM", + "description": "(BETA) Computes outlier detection for the provided execution definition.", + "operationId": "outlierDetection", "parameters": [ { "description": "Workspace identifier", @@ -8913,27 +6978,13 @@ } }, { - "description": "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request\n\n`GIT` - Git properties of current build", - "in": "query", - "name": "explainType", + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", "required": false, "schema": { - "enum": [ - "MAQL", - "GRPC_MODEL", - "GRPC_MODEL_SVG", - "WDF", - "QT", - "QT_SVG", - "OPT_QT", - "OPT_QT_SVG", - "SQL", - "SETTINGS", - "COMPRESSED_SQL", - "COMPRESSED_GRPC_MODEL_SVG", - "GIT" - ], - "type": "string" + "default": false, + "type": "boolean" } } ], @@ -8941,7 +6992,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmExecution" + "$ref": "#/components/schemas/OutlierDetectionRequest" } } }, @@ -8950,37 +7001,26 @@ "responses": { "200": { "content": { - "application/json": {}, - "application/sql": {}, - "application/zip": { + "application/json": { "schema": { - "description": "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/OutlierDetectionResponse" } - }, - "image/svg+xml": {} + } }, - "description": "Requested resource" + "description": "OK" } }, - "summary": "AFM explain resource.", + "summary": "(BETA) Outlier Detection", "tags": [ "Computation", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to analyze data.", - "permissions": [ - "ANALYZE" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": { - "post": { - "description": "Returns paged list of elements (values) of given label satisfying given filtering criteria.", - "operationId": "computeLabelElementsPost", + "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}": { + "get": { + "description": "(BETA) Gets outlier detection result.", + "operationId": "outlierDetectionResult", "parameters": [ { "description": "Workspace identifier", @@ -8993,81 +7033,57 @@ } }, { - "description": "Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in": "path", + "name": "resultId", + "required": true, + "schema": { + "type": "string" + } + }, + { "in": "query", "name": "offset", "required": false, "schema": { - "default": 0, "format": "int32", - "maximum": 10000, - "minimum": 0, "type": "integer" } }, { - "description": "Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", "in": "query", "name": "limit", "required": false, "schema": { - "default": 1000, "format": "int32", - "maximum": 10000, - "minimum": 1, "type": "integer" } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementsRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ElementsResponse" + "$ref": "#/components/schemas/OutlierDetectionResult" } } }, - "description": "List of label values." + "description": "OK" } }, - "summary": "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", + "summary": "(BETA) Outlier Detection Result", "tags": [ "Computation", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", - "permissions": [ - "VIEW" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow": { "post": { - "description": "Computes change analysis for the provided execution definition.", - "operationId": "changeAnalysis", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.", + "operationId": "executeFlow", "parameters": [ { "description": "Workspace identifier", @@ -9084,7 +7100,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChangeAnalysisRequest" + "$ref": "#/components/schemas/FlowRequest" } } }, @@ -9095,24 +7111,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChangeAnalysisResponse" + "$ref": "#/components/schemas/FlowExecutionResponse" } } }, - "description": "OK" + "description": "The flow was accepted.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "Token that cancels the flow when it is given to the cancel endpoint.", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, - "summary": "Compute change analysis", + "summary": "(EXPERIMENTAL) Execute a flow", "tags": [ - "Computation", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to run a flow.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}": { - "get": { - "description": "Gets change analysis result.", - "operationId": "changeAnalysisResult", + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel": { + "post": { + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.", + "operationId": "cancelFlows", "parameters": [ { "description": "Workspace identifier", @@ -9123,41 +7154,47 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmCancelTokens" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChangeAnalysisResult" + "$ref": "#/components/schemas/AfmCancelTokens" } } }, "description": "OK" } }, - "summary": "Get change analysis result", + "summary": "(EXPERIMENTAL) Apply the given cancel tokens to flows", "tags": [ - "Computation", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to cancel a flow.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { - "post": { - "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", - "operationId": "keyDriverAnalysis", + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/operations": { + "get": { + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.", + "operationId": "listFlowOperations", "parameters": [ { "description": "Workspace identifier", @@ -9168,51 +7205,37 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyDriversRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/KeyDriversResponse" + "$ref": "#/components/schemas/FlowOperations" } } }, "description": "OK" } }, - "summary": "(EXPERIMENTAL) Compute key driver analysis", + "summary": "(EXPERIMENTAL) List the operations of flows", "tags": [ - "Computation", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to list the operations of flows.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary": { "get": { - "description": "(EXPERIMENTAL) Gets key driver analysis.", - "operationId": "keyDriverAnalysisResult", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.", + "operationId": "retrieveFlowResultBinary", "parameters": [ { "description": "Workspace identifier", @@ -9235,8 +7258,9 @@ } }, { + "description": "Index of the first row to return. The default is 0.", "in": "query", - "name": "offset", + "name": "rowOffset", "required": false, "schema": { "format": "int32", @@ -9244,8 +7268,29 @@ } }, { + "description": "Maximum number of rows to return. The default is all remaining rows.", "in": "query", - "name": "limit", + "name": "rowLimit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Index of the first column to return. The default is 0.", + "in": "query", + "name": "columnOffset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Maximum number of columns to return. The default is all remaining columns.", + "in": "query", + "name": "columnLimit", "required": false, "schema": { "format": "int32", @@ -9256,26 +7301,39 @@ "responses": { "200": { "content": { - "application/json": { + "application/vnd.apache.arrow.file": { "schema": { - "$ref": "#/components/schemas/KeyDriversResult" + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { + "schema": { + "format": "binary", + "type": "string" } } }, - "description": "OK" + "description": "The result." } }, - "summary": "(EXPERIMENTAL) Get key driver analysis result", + "summary": "(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format", "tags": [ - "Computation", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to read a flow result.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers": { - "post": { - "description": "(BETA) Computes outlier detection for the provided execution definition.", - "operationId": "outlierDetection", + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata": { + "get": { + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.", + "operationId": "retrieveFlowResultMetadata", "parameters": [ { "description": "Workspace identifier", @@ -9288,49 +7346,45 @@ } }, { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in": "path", + "name": "resultId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OutlierDetectionRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OutlierDetectionResponse" + "$ref": "#/components/schemas/FlowResultMetadata" } } }, "description": "OK" } }, - "summary": "(BETA) Outlier Detection", + "summary": "(EXPERIMENTAL) Get the metadata of a flow result", "tags": [ - "Computation", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to read a flow result.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table": { "get": { - "description": "(BETA) Gets outlier detection result.", - "operationId": "outlierDetectionResult", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.", + "operationId": "retrieveFlowResultTable", "parameters": [ { "description": "Workspace identifier", @@ -9353,8 +7407,9 @@ } }, { + "description": "Index of the first row to return. The default is 0.", "in": "query", - "name": "offset", + "name": "rowOffset", "required": false, "schema": { "format": "int32", @@ -9362,8 +7417,29 @@ } }, { + "description": "Maximum number of rows to return. The default is all remaining rows.", "in": "query", - "name": "limit", + "name": "rowLimit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Index of the first column to return. The default is 0.", + "in": "query", + "name": "columnOffset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Maximum number of columns to return. The default is all remaining columns.", + "in": "query", + "name": "columnLimit", "required": false, "schema": { "format": "int32", @@ -9376,18 +7452,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OutlierDetectionResult" + "$ref": "#/components/schemas/FlowTableResult" } } }, "description": "OK" } }, - "summary": "(BETA) Outlier Detection Result", + "summary": "(EXPERIMENTAL) Get a page of a flow result", "tags": [ - "Computation", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to read a flow result.", + "permissions": [ + "VIEW" + ] + } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}": { @@ -9986,7 +8068,7 @@ }, "/api/v1/ailake/database/instances/{instanceId}": { "delete": { - "description": "(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", + "description": "(BETA) Deletes an existing database in the organization's AI Lake. A database that still contains tables is not deleted, unless cascade is set. With cascade, every table in the database is dropped first, which cannot be undone. Returns an operation-id in the operation-id header the client can use to poll for the progress.", "operationId": "deprovisionAiLakeDatabaseInstance", "parameters": [ { @@ -9999,6 +8081,16 @@ "type": "string" } }, + { + "description": "Drop every table in the database before the database itself.", + "in": "query", + "name": "cascade", + "required": false, + "schema": { + "description": "Drop every table in the database before the database itself.", + "type": "boolean" + } + }, { "in": "header", "name": "operation-id", @@ -10088,7 +8180,7 @@ }, "/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics": { "post": { - "description": "(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.", + "description": "(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.", "operationId": "analyzeStatistics", "parameters": [ { @@ -10125,213 +8217,44 @@ "content": {}, "description": "Statistics analysis scheduled.", "headers": { - "operation-id": { - "schema": { - "format": "uuid", - "type": "string" - }, - "style": "simple" - } - } - } - }, - "summary": "(BETA) Run ANALYZE TABLE for tables in a database instance", - "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to analyze statistics.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/ailake/database/instances/{instanceId}/dataSource": { - "patch": { - "description": "(BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.", - "operationId": "updateAiLakeDatabaseDataSource", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateDatabaseDataSourceRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UpdateDatabaseDataSourceResponse" - } - } - }, - "description": "Data source successfully updated" - } - }, - "summary": "(BETA) Update the data source of an AILake Database instance", - "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to update the data source of an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/ailake/database/instances/{instanceId}/dataSources": { - "get": { - "description": "(BETA) Returns data source associations for the specified AI Lake database instance.", - "operationId": "listAiLakeDatabaseDataSources", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, - { - "description": "Zero-based page number.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "description": "Zero-based page number.", - "format": "int32", - "minimum": 0, - "type": "integer" - } - }, - { - "description": "Number of items per page.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 50, - "description": "Number of items per page.", - "format": "int32", - "maximum": 500, - "minimum": 1, - "type": "integer" - } - }, - { - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array", - "uniqueItems": true - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentDataSourceInfo" - } - } - }, - "description": "Data sources successfully retrieved" - } - }, - "summary": "(BETA) List data sources of an AILake Database instance", - "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to list data sources of an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } - }, - "post": { - "description": "(BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.", - "operationId": "addAiLakeDatabaseDataSource", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddDatabaseDataSourceRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, "schema": { - "$ref": "#/components/schemas/AddDatabaseDataSourceResponse" - } + "type": "string" + }, + "style": "simple" + }, + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" } - }, - "description": "Data source successfully added" + } } }, - "summary": "(BETA) Add a data source to an AILake Database instance", + "summary": "(BETA) Run ANALYZE TABLE for tables in a database instance", "tags": [ "AI Lake - Databases", "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to add a data source to an AI Lake database instance.", + "description": "Permissions required to analyze statistics.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}": { - "delete": { - "description": "(BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.", - "operationId": "removeAiLakeDatabaseDataSource", + "/api/v1/ailake/database/instances/{instanceId}/dataSource": { + "patch": { + "description": "(BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.", + "operationId": "updateAiLakeDatabaseDataSource", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", @@ -10342,47 +8265,47 @@ "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } - }, - { - "description": "Identifier of the data source to remove.", - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "description": "Identifier of the data source to remove.", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateDatabaseDataSourceRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemoveDatabaseDataSourceResponse" + "$ref": "#/components/schemas/UpdateDatabaseDataSourceResponse" } } }, - "description": "Data source successfully removed" + "description": "Data source successfully updated" } }, - "summary": "(BETA) Remove a data source from an AILake Database instance", + "summary": "(BETA) Update the data source of an AILake Database instance", "tags": [ "AI Lake - Databases", "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to remove a data source from an AI Lake database instance.", + "description": "Permissions required to update the data source of an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/ailake/database/instances/{instanceId}/pipeTables": { + "/api/v1/ailake/database/instances/{instanceId}/dataSources": { "get": { - "description": "(BETA) Lists active pipe tables in the given AI Lake database instance.", - "operationId": "listAiLakePipeTables", + "description": "(BETA) Returns data source associations for the specified AI Lake database instance.", + "operationId": "listAiLakeDatabaseDataSources", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", @@ -10439,28 +8362,28 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentPipeTableSummary" + "$ref": "#/components/schemas/JsonApiListDocumentDataSourceInfo" } } }, - "description": "AI Lake pipe tables successfully retrieved" + "description": "Data sources successfully retrieved" } }, - "summary": "(BETA) List AI Lake pipe tables", + "summary": "(BETA) List data sources of an AILake Database instance", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to list AI Lake pipe tables.", + "description": "Permissions required to list data sources of an AI Lake database instance.", "permissions": [ "MANAGE" ] } }, "post": { - "description": "(BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.", - "operationId": "createAiLakePipeTable", + "description": "(BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.", + "operationId": "addAiLakeDatabaseDataSource", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", @@ -10471,140 +8394,47 @@ "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } - }, - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePipeTableRequest" + "$ref": "#/components/schemas/AddDatabaseDataSourceRequest" } } }, "required": true }, "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "operation-location": { - "description": "Operation location URL.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "200": { + "content": { + "application/json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/AddDatabaseDataSourceResponse" + } } - } + }, + "description": "Data source successfully added" } }, - "summary": "(BETA) Create a new AI Lake pipe table", + "summary": "(BETA) Add a data source to an AILake Database instance", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to create an AI Lake pipe table.", + "description": "Permissions required to add a data source to an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}": { + "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}": { "delete": { - "description": "(BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress.", - "operationId": "deleteAiLakePipeTable", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, - { - "description": "Pipe table name.", - "in": "path", - "name": "tableName", - "required": true, - "schema": { - "description": "Pipe table name.", - "type": "string" - } - }, - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "operation-location": { - "description": "Operation location URL.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } - } - }, - "summary": "(BETA) Delete an AI Lake pipe table", - "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to delete an AI Lake pipe table.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "description": "(BETA) Returns full details of the specified pipe table.", - "operationId": "getAiLakePipeTable", + "description": "(BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.", + "operationId": "removeAiLakeDatabaseDataSource", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", @@ -10617,12 +8447,12 @@ } }, { - "description": "Pipe table name.", + "description": "Identifier of the data source to remove.", "in": "path", - "name": "tableName", + "name": "dataSourceId", "required": true, "schema": { - "description": "Pipe table name.", + "description": "Identifier of the data source to remove.", "type": "string" } } @@ -10632,103 +8462,20 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDocumentPipeTable" + "$ref": "#/components/schemas/RemoveDatabaseDataSourceResponse" } } }, - "description": "AI Lake pipe table successfully retrieved" - } - }, - "summary": "(BETA) Get an AI Lake pipe table", - "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to get an AI Lake pipe table.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh": { - "post": { - "description": "(BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress.", - "operationId": "refreshAiLakePipeTablePartition", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, - { - "description": "Pipe table name.", - "in": "path", - "name": "tableName", - "required": true, - "schema": { - "description": "Pipe table name.", - "type": "string" - } - }, - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/RefreshPartitionRequest" - } - } - }, - "required": true - }, - "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "operation-location": { - "description": "Operation location URL.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } + "description": "Data source successfully removed" } }, - "summary": "(BETA) Refresh a pipe table partition", + "summary": "(BETA) Remove a data source from an AILake Database instance", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to refresh an AI Lake pipe table partition.", + "description": "Permissions required to remove a data source from an AI Lake database instance.", "permissions": [ "MANAGE" ] @@ -10737,7 +8484,7 @@ }, "/api/v1/ailake/objectStorages": { "get": { - "description": "(BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.", + "description": "(BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.", "operationId": "listAiLakeObjectStorages", "parameters": [ { diff --git a/schemas/gooddata-api-client.json b/schemas/gooddata-api-client.json index 820b7cd91..34ad9242e 100644 --- a/schemas/gooddata-api-client.json +++ b/schemas/gooddata-api-client.json @@ -172,7 +172,6 @@ "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", "example": "2012-05", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" }, "granularity": { @@ -229,7 +228,6 @@ "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", "example": "2012-08", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" } }, @@ -262,29 +260,6 @@ ], "type": "object" }, - "ActiveObjectIdentification": { - "description": "Object, with which the user is actively working.", - "properties": { - "id": { - "description": "Object ID.", - "type": "string" - }, - "type": { - "description": "Object type, e.g. dashboard.", - "type": "string" - }, - "workspaceId": { - "description": "Workspace ID.", - "type": "string" - } - }, - "required": [ - "id", - "type", - "workspaceId" - ], - "type": "object" - }, "AdHocAutomation": { "properties": { "alert": { @@ -464,6 +439,34 @@ ], "type": "object" }, + "AfmFlowInput": { + "allOf": [ + { + "properties": { + "execution": { + "$ref": "#/components/schemas/AFM" + }, + "settings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "type": { + "description": "Type of the input.", + "enum": [ + "afm" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Computes an AFM as /afm/execute does, and reads its rows as a table. It has a column for each attribute and each measure of the AFM, named by its local identifier, the attributes first. Each attribute must use a label of its own.", + "required": [ + "execution", + "type" + ], + "type": "object" + }, "AfmIdentifier": { "description": "Reference to the attribute label to which the filter should be applied.", "oneOf": [ @@ -503,6 +506,7 @@ "enum": [ "analyticalDashboard", "attribute", + "computedAttribute", "dashboardPlugin", "dataset", "fact", @@ -572,7 +576,8 @@ "attribute", "label", "fact", - "metric" + "metric", + "computedAttribute" ], "type": "string" } @@ -629,7 +634,8 @@ }, "type": { "enum": [ - "label" + "label", + "computedAttribute" ], "type": "string" } @@ -723,7 +729,8 @@ "enum": [ "facts", "attributes", - "measures" + "measures", + "computedAttributes" ], "example": "facts", "type": "string" @@ -753,54 +760,6 @@ ], "type": "object" }, - "AggregateKeyConfig": { - "description": "Aggregate key model — pre-aggregates rows sharing the same key columns.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "aggregate" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "AiUsageMetadataItem": { - "description": "AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).", - "properties": { - "counterType": { - "description": "Type of usage counter, e.g. AI_QUERIES.", - "type": "string" - }, - "currentValue": { - "description": "Current usage value after this request.", - "format": "int64", - "type": "integer" - }, - "limit": { - "description": "Entitlement limit. 0 means unlimited.", - "format": "int64", - "type": "integer" - } - }, - "required": [ - "counterType", - "currentValue", - "limit" - ], - "type": "object" - }, "AlertAfm": { "properties": { "attributes": { @@ -1049,49 +1008,6 @@ ], "type": "object" }, - "AllowedRelationshipType": { - "description": "Allowed relationship type combination.", - "properties": { - "allowOrphans": { - "default": true, - "description": "If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).", - "type": "boolean" - }, - "sourceType": { - "description": "Source object type (e.g., 'dashboard', 'visualization', 'metric').", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "targetType": { - "description": "Target object type (e.g., 'visualization', 'metric', 'attribute').", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - } - }, - "required": [ - "sourceType", - "targetType" - ], - "type": "object" - }, "AmplitudeService": { "description": "Amplitude service.", "properties": { @@ -1373,24 +1289,6 @@ ], "type": "object" }, - "AnomalyDetectionConfig": { - "description": "Anomaly detection configuration.", - "properties": { - "sensitivity": { - "description": "Outlier sensitivity level.", - "enum": [ - "LOW", - "MEDIUM", - "HIGH" - ], - "type": "string" - } - }, - "required": [ - "sensitivity" - ], - "type": "object" - }, "AnomalyDetectionRequest": { "properties": { "sensitivity": { @@ -1935,32 +1833,6 @@ ], "type": "object" }, - "AttributeNegativeFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "exclude": { - "items": { - "type": "string" - }, - "type": "array" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "exclude", - "using" - ], - "type": "object" - }, "AttributePermissions": { "properties": { "rules": { @@ -2054,32 +1926,6 @@ ], "type": "object" }, - "AttributePositiveFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "include": { - "items": { - "type": "string" - }, - "type": "array" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "include", - "using" - ], - "type": "object" - }, "AttributeResultHeader": { "description": "Header containing the information related to attributes.", "properties": { @@ -2119,6 +1965,9 @@ ], "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", @@ -2725,75 +2574,6 @@ ], "type": "object" }, - "CertificationInfo": { - "description": "Certification state of the object. Who certified and when are never exposed here.", - "properties": { - "certificationMessage": { - "description": "Optional message describing the certification.", - "type": "string" - }, - "status": { - "description": "Certification status, e.g. CERTIFIED.", - "type": "string" - } - }, - "required": [ - "status" - ], - "type": "object" - }, - "ChangeAnalysisParams": { - "description": "Change analysis specification.", - "properties": { - "analyzedPeriod": { - "description": "The analyzed time period", - "type": "string" - }, - "attributes": { - "description": "Attributes to analyze for significant changes", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" - }, - "dateAttribute": { - "$ref": "#/components/schemas/AttributeItem" - }, - "filters": { - "description": "Optional filters to apply", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "measure": { - "$ref": "#/components/schemas/MeasureItem" - }, - "measureTitle": { - "description": "The title of the measure being analyzed", - "type": "string" - }, - "referencePeriod": { - "description": "The reference time period", - "type": "string" - }, - "useSmartAttributeSelection": { - "description": "Whether to use smart attribute selection", - "type": "boolean" - } - }, - "required": [ - "analyzedPeriod", - "attributes", - "dateAttribute", - "filters", - "measure", - "measureTitle", - "referencePeriod", - "useSmartAttributeSelection" - ], - "type": "object" - }, "ChangeAnalysisRequest": { "description": "Request for change analysis computation", "properties": { @@ -2890,313 +2670,6 @@ ], "type": "object" }, - "ChatHistoryInteraction": { - "description": "List of chat history interactions.", - "properties": { - "changeAnalysisParams": { - "$ref": "#/components/schemas/ChangeAnalysisParams" - }, - "chatHistoryInteractionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "type": "string" - }, - "createdVisualizations": { - "$ref": "#/components/schemas/CreatedVisualizations" - }, - "errorResponse": { - "description": "Error response in anything fails.", - "type": "string" - }, - "foundObjects": { - "$ref": "#/components/schemas/FoundObjects" - }, - "interactionFinished": { - "description": "Has the interaction already finished? Can be used for polling when interaction is in progress.", - "type": "boolean" - }, - "question": { - "description": "User question", - "maxLength": 2000, - "type": "string" - }, - "reasoning": { - "$ref": "#/components/schemas/Reasoning" - }, - "routing": { - "$ref": "#/components/schemas/RouteResult" - }, - "semanticSearch": { - "$ref": "#/components/schemas/SearchResult" - }, - "textResponse": { - "description": "Text response for general questions.", - "type": "string" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "userFeedback": { - "description": "User feedback.", - "enum": [ - "POSITIVE", - "NEGATIVE", - "NONE" - ], - "type": "string" - } - }, - "required": [ - "chatHistoryInteractionId", - "interactionFinished", - "question", - "routing" - ], - "type": "object" - }, - "ChatHistoryRequest": { - "properties": { - "chatHistoryInteractionId": { - "description": "Return chat history records only after this interaction ID. If empty, complete chat history is returned.", - "type": "string" - }, - "reset": { - "description": "User feedback.", - "type": "boolean" - }, - "responseState": { - "description": "Response state indicating the outcome of the AI interaction.", - "enum": [ - "SUCCESSFUL", - "UNEXPECTED_ERROR", - "NOT_FOUND_ATTRIBUTES", - "TOO_MANY_DATA_POINTS", - "NO_DATA", - "NO_RESULTS", - "OUT_OF_TOPIC" - ], - "type": "string" - }, - "savedVisualization": { - "$ref": "#/components/schemas/SavedVisualization" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "userFeedback": { - "description": "User feedback.", - "enum": [ - "POSITIVE", - "NEGATIVE", - "NONE" - ], - "type": "string" - }, - "userTextFeedback": { - "description": "User text feedback for the interaction.", - "type": "string" - } - }, - "type": "object" - }, - "ChatHistoryResult": { - "properties": { - "interactions": { - "description": "List of chat history interactions.", - "items": { - "$ref": "#/components/schemas/ChatHistoryInteraction" - }, - "type": "array" - }, - "threadId": { - "description": "The conversation thread ID.", - "type": "string" - } - }, - "required": [ - "interactions", - "threadId" - ], - "type": "object" - }, - "ChatRequest": { - "properties": { - "allowedRelationshipTypes": { - "description": "Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).", - "items": { - "$ref": "#/components/schemas/AllowedRelationshipType" - }, - "type": "array" - }, - "includeHidden": { - "default": false, - "description": "If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.", - "type": "boolean" - }, - "limitCreate": { - "default": 3, - "description": "Maximum number of created results.", - "format": "int32", - "type": "integer" - }, - "limitCreateContext": { - "default": 10, - "description": "Maximum number of relevant objects included into context for LLM (for each object type).", - "format": "int32", - "type": "integer" - }, - "limitSearch": { - "default": 5, - "description": "Maximum number of search results.", - "format": "int32", - "type": "integer" - }, - "objectTypes": { - "description": "List of object types to filter the search and visualization building. If empty or null, all object types are considered.", - "items": { - "description": "Object type to filter.", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], - "type": "string" - }, - "type": "array" - }, - "question": { - "description": "User question", - "maxLength": 2000, - "type": "string" - }, - "relevantScoreThreshold": { - "default": 0.45, - "description": "Score, above which we return found objects. Below this score objects are not relevant.", - "format": "double", - "type": "number" - }, - "searchScoreThreshold": { - "default": 0.9, - "description": "Score, above which we return found object(s) and don't call LLM to create new objects.", - "format": "double", - "type": "number" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "titleToDescriptorRatio": { - "default": 0.7, - "description": "Temporary for experiments. Ratio of title score to descriptor score.", - "format": "double", - "type": "number" - }, - "userContext": { - "$ref": "#/components/schemas/UserContext" - } - }, - "required": [ - "question" - ], - "type": "object" - }, - "ChatResult": { - "properties": { - "changeAnalysisParams": { - "$ref": "#/components/schemas/ChangeAnalysisParams" - }, - "chatHistoryInteractionId": { - "description": "Chat History interaction ID. Unique ID for each interaction.", - "type": "string" - }, - "createdVisualizations": { - "$ref": "#/components/schemas/CreatedVisualizations" - }, - "errorResponse": { - "description": "Error response in anything fails.", - "type": "string" - }, - "foundObjects": { - "$ref": "#/components/schemas/FoundObjects" - }, - "reasoning": { - "$ref": "#/components/schemas/Reasoning" - }, - "routing": { - "$ref": "#/components/schemas/RouteResult" - }, - "semanticSearch": { - "$ref": "#/components/schemas/SearchResult" - }, - "textResponse": { - "description": "Text response for general questions.", - "type": "string" - }, - "threadIdSuffix": { - "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", - "type": "string" - }, - "usage": { - "description": "AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).", - "items": { - "$ref": "#/components/schemas/AiUsageMetadataItem" - }, - "type": "array" - } - }, - "type": "object" - }, - "ChatUsageResponse": { - "properties": { - "interactionCount": { - "description": "Number of interactions in the time window", - "format": "int32", - "type": "integer" - }, - "interactionLimit": { - "description": "Maximum number of interactions in the time window any user can do in the workspace", - "format": "int32", - "type": "integer" - }, - "timeWindowHours": { - "description": "Time window in hours", - "format": "int32", - "type": "integer" - } - }, - "required": [ - "interactionCount", - "interactionLimit", - "timeWindowHours" - ], - "type": "object" - }, - "ClusteringConfig": { - "description": "Clustering configuration.", - "properties": { - "numberOfClusters": { - "description": "Number of clusters to create", - "format": "int32", - "type": "integer" - }, - "threshold": { - "description": "Clustering algorithm threshold", - "format": "float", - "type": "number" - } - }, - "required": [ - "numberOfClusters", - "threshold" - ], - "type": "object" - }, "ClusteringRequest": { "properties": { "numberOfClusters": { @@ -3235,30 +2708,16 @@ }, "type": "array" }, - "xCoord": { - "items": { - "nullable": true, - "type": "number" - }, - "type": "array", - "writeOnly": true - }, "xcoord": { - "items": { - "type": "number" - }, - "type": "array" - }, - "yCoord": { "items": { "nullable": true, "type": "number" }, - "type": "array", - "writeOnly": true + "type": "array" }, "ycoord": { "items": { + "nullable": true, "type": "number" }, "type": "array" @@ -3272,48 +2731,6 @@ ], "type": "object" }, - "ColumnExpression": { - "description": "Single column projection override: applies `function(column)` to a source column.", - "properties": { - "column": { - "description": "Source column produced by parquet schema inference (after columnOverrides).", - "type": "string" - }, - "function": { - "description": "StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.", - "enum": [ - "HLL_HASH", - "BITMAP_HASH", - "BITMAP_HASH64", - "TO_BITMAP" - ], - "type": "string" - } - }, - "required": [ - "column", - "function" - ], - "type": "object" - }, - "ColumnInfo": { - "description": "A single column definition inferred from the parquet schema", - "properties": { - "name": { - "description": "Column name", - "type": "string" - }, - "type": { - "description": "SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE)", - "type": "string" - } - }, - "required": [ - "name", - "type" - ], - "type": "object" - }, "ColumnLocation": { "type": "object" }, @@ -3361,30 +2778,6 @@ ], "type": "object" }, - "ColumnPartitionConfig": { - "description": "Partition by column expression.", - "properties": { - "columns": { - "description": "Columns to partition by.", - "items": { - "description": "Columns to partition by.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "column" - ], - "type": "string" - } - }, - "required": [ - "columns", - "type" - ], - "type": "object" - }, "ColumnStatistic": { "properties": { "type": { @@ -3722,433 +3115,859 @@ ], "type": "object" }, - "ContentSlideTemplate": { - "description": "Settings for content slide.", - "nullable": true, + "ComputedAttributePermissions": { "properties": { - "descriptionField": { - "example": "{{dashboardFilters}}", - "nullable": true, - "type": "string" + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" }, - "footer": { - "$ref": "#/components/schemas/RunningSection" + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" }, - "header": { - "$ref": "#/components/schemas/RunningSection" + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" } }, + "required": [ + "rules", + "userGroups", + "users" + ], "type": "object" }, - "ConvertGeoFileRequest": { - "description": "Request to convert a geo file to GeoParquet format.", + "ComputedAttributePermissionsAssignment": { + "description": "Desired levels of permissions on a computed attribute for an assignee.", "properties": { - "location": { - "description": "Location of the file in the staging area to convert.", - "minLength": 1, - "type": "string" + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "location" + "permissions" ], "type": "object" }, - "ConvertGeoFileResponse": { - "description": "Response after successfully converting a geo file.", - "properties": { - "location": { - "description": "Location of the converted GeoParquet file in the staging area.", - "type": "string" + "ComputedAttributePermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/ComputedAttributePermissionsAssignment" + }, + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" } - }, + ], + "description": "Desired levels of computed-attribute permissions for an assignee identified by an identifier.", "required": [ - "location" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "CoverSlideTemplate": { - "description": "Settings for cover slide.", + "ComputedAttributePermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/ComputedAttributePermissionsAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of computed-attribute permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "ConditionalFormatting": { + "description": "Conditional formatting for a table, with one entry per formatted column.", "nullable": true, "properties": { - "backgroundImage": { - "default": true, - "description": "Show background image on the slide.", + "enabled": { + "description": "Whether the rules are applied when rendering.", "type": "boolean" }, - "descriptionField": { - "example": "Exported at: {{exportedAt}}", - "nullable": true, - "type": "string" - }, - "footer": { - "$ref": "#/components/schemas/RunningSection" - }, - "header": { - "$ref": "#/components/schemas/RunningSection" + "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" }, - "CreatePipeTableRequest": { - "description": "Request to create a new pipe-backed OLAP table in the AI Lake", - "properties": { - "aggregationOverrides": { - "additionalProperties": { - "description": "Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.", - "type": "string" - }, - "description": "Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.", - "type": "object" - }, - "columnExpressions": { - "additionalProperties": { - "$ref": "#/components/schemas/ColumnExpression" - }, - "description": "Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).", - "type": "object" - }, - "columnOverrides": { - "additionalProperties": { - "description": "Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.", - "type": "string" - }, - "description": "Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.", - "type": "object" - }, - "distributionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/HashDistributionConfig" - }, - { - "$ref": "#/components/schemas/RandomDistributionConfig" - } - ] - }, - "keyConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AggregateKeyConfig" - }, - { - "$ref": "#/components/schemas/DuplicateKeyConfig" - }, - { - "$ref": "#/components/schemas/PrimaryKeyConfig" - }, - { - "$ref": "#/components/schemas/UniqueKeyConfig" - } - ] - }, - "maxVarcharLength": { - "description": "Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.", - "format": "int32", - "type": "integer" - }, - "partitionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/ColumnPartitionConfig" + "ConditionalFormattingAbsoluteDateValue": { + "allOf": [ + { + "properties": { + "from": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.", + "type": "string" }, - { - "$ref": "#/components/schemas/DateTruncPartitionConfig" + "kind": { + "description": "The value kind.", + "enum": [ + "absoluteDate" + ], + "type": "string" }, - { - "$ref": "#/components/schemas/TimeSlicePartitionConfig" + "to": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.", + "type": "string" } - ] - }, - "pathPrefix": { - "description": "Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.", + }, + "type": "object" + } + ], + "description": "A fixed, inclusive date period.", + "properties": { + "from": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.", "type": "string" }, - "pollingIntervalSeconds": { - "description": "How often (in seconds) the pipe polls for new files. 0 or null = use server default.", - "format": "int32", - "type": "integer" - }, - "sourceStorageName": { - "description": "Name of the pre-configured S3/MinIO ObjectStorage source", + "kind": { + "description": "The value kind.", + "enum": [ + "absoluteDate" + ], "type": "string" }, - "tableName": { - "description": "Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$", + "to": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.", "type": "string" - }, - "tableProperties": { - "additionalProperties": { - "description": "CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.", - "type": "string" - }, - "description": "CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.", - "type": "object" } }, "required": [ - "pathPrefix", - "sourceStorageName", - "tableName" + "from", + "kind", + "to" ], "type": "object" }, - "CreatedVisualization": { - "description": "List of created visualization objects", - "properties": { - "config": { - "$ref": "#/components/schemas/VisualizationConfig" - }, - "dimensionality": { - "description": "List of attributes representing the dimensionality of the new visualization", - "items": { - "$ref": "#/components/schemas/DimAttribute" - }, - "type": "array" - }, - "filters": { - "description": "List of filters to be applied to the new visualization", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributeNegativeFilter" - }, - { - "$ref": "#/components/schemas/AttributePositiveFilter" - }, - { - "$ref": "#/components/schemas/DateAbsoluteFilter" - }, - { - "$ref": "#/components/schemas/DateRelativeFilter" - }, - { - "$ref": "#/components/schemas/GenAiRankingFilter" - } - ] - }, - "type": "array" - }, - "id": { - "description": "Proposed ID of the new visualization", - "example": "revenue_by_country", - "type": "string" - }, - "metrics": { - "description": "List of metrics to be used in the new visualization", - "items": { - "$ref": "#/components/schemas/Metric" - }, - "type": "array" - }, - "savedVisualizationId": { - "description": "Saved visualization ID.", - "type": "string" - }, - "suggestions": { - "description": "Suggestions for next steps", - "items": { - "$ref": "#/components/schemas/Suggestion" + "ConditionalFormattingAttributeTarget": { + "allOf": [ + { + "properties": { + "attributeIdentifier": { + "example": "23990482d9d04e62a9c564a29be804f8", + "type": "string" + }, + "kind": { + "description": "The target kind.", + "enum": [ + "attribute" + ], + "type": "string" + } }, - "type": "array" - }, - "title": { - "description": "Proposed title of the new visualization", - "example": "Revenue by Country", + "type": "object" + } + ], + "description": "An attribute column, addressed by its bucket item local identifier.", + "properties": { + "attributeIdentifier": { + "example": "23990482d9d04e62a9c564a29be804f8", "type": "string" }, - "visualizationType": { - "description": "Visualization type requested in question", + "kind": { + "description": "The target kind.", "enum": [ - "TABLE", - "HEADLINE", - "BAR", - "LINE", - "PIE", - "COLUMN", - "SCATTER" + "attribute" ], - "example": "TABLE", "type": "string" } }, "required": [ - "dimensionality", - "filters", - "id", - "metrics", - "suggestions", - "title", - "visualizationType" + "attributeIdentifier", + "kind" ], "type": "object" }, - "CreatedVisualizations": { - "description": "Visualization definitions created by AI.", + "ConditionalFormattingCondition": { + "description": "A condition and the formatting applied to cells matching it.", "properties": { - "objects": { - "description": "List of created visualization objects", - "items": { - "$ref": "#/components/schemas/CreatedVisualization" - }, - "type": "array" + "format": { + "$ref": "#/components/schemas/ConditionalFormattingFormat" }, - "reasoning": { - "deprecated": true, - "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "d0538854-aac3-4fc6-9603-61f49bab6aa3", "type": "string" }, - "suggestions": { - "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", - "items": { - "$ref": "#/components/schemas/Suggestion" - }, - "type": "array" + "operator": { + "description": "How a condition compares the cell value against its value.", + "enum": [ + "ALL", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN", + "LESS_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "BETWEEN", + "NOT_BETWEEN", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "ENDS_WITH", + "NOT_ENDS_WITH", + "IS_EMPTY", + "IS_NOT_EMPTY" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingValue" } }, "required": [ - "objects", - "reasoning", - "suggestions" + "format", + "operator", + "value" ], "type": "object" }, - "CsvConvertOptions": { - "description": "Options for converting CSV files when reading.", + "ConditionalFormattingFormat": { + "description": "Visual formatting applied to a matching cell.", "properties": { - "autoDictEncode": { - "description": "Whether to try to automatically dict-encode string / binary data.", - "type": "boolean" - }, - "autoDictMaxCardinality": { - "description": "The maximum dictionary cardinality for autoDictEncode.", - "format": "int32", - "type": "integer" - }, - "checkUtf8": { - "description": "Whether to check UTF8 validity of string columns.", - "type": "boolean" - }, - "columnTypes": { - "description": "Information about the column types in the table.", - "items": { - "$ref": "#/components/schemas/CsvConvertOptionsColumnType" - }, - "type": "array" - }, - "decimalPoint": { - "description": "The character used as decimal point in floating-point and decimal data.", + "backgroundColor": { + "description": "Background color as a hex triplet.", + "example": "#3DB36B", "type": "string" }, - "falseValues": { - "description": "Sequence of strings that denote false Booleans in the data.", - "items": { - "description": "Sequence of strings that denote false Booleans in the data.", - "type": "string" - }, - "type": "array" - }, - "includeColumns": { - "description": "The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.", - "items": { - "description": "The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.", - "type": "string" - }, - "type": "array" - }, - "includeMissingColumns": { - "description": "If false, columns in includeColumns but not in the CSV file will error out.", - "type": "boolean" - }, - "nullValues": { - "description": "Sequence of strings that denote nulls in the data.", - "items": { - "description": "Sequence of strings that denote nulls in the data.", - "type": "string" - }, - "type": "array" - }, - "quotedStringsCanBeNull": { - "description": "Whether quoted values can be null.", - "type": "boolean" - }, - "stringsCanBeNull": { - "description": "Whether string / binary columns can have null values.", - "type": "boolean" - }, - "timestampParsers": { - "description": "Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.", - "items": { - "description": "Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.", - "type": "string" - }, - "type": "array" + "color": { + "description": "Text color as a hex triplet.", + "example": "#E54D40", + "type": "string" }, - "trueValues": { - "description": "Sequence of strings that denote true Booleans in the data.", - "items": { - "description": "Sequence of strings that denote true Booleans in the data.", - "type": "string" - }, - "type": "array" + "scope": { + "description": "Whether the formatting applies to the matching cell only, or to its whole row.", + "enum": [ + "cell", + "row" + ], + "type": "string" } }, + "required": [ + "scope" + ], "type": "object" }, - "CsvConvertOptionsColumnType": { - "description": "Information about a certain column in the table.", - "properties": { - "name": { - "description": "The column name.", + "ConditionalFormattingLiteral": { + "description": "A string or a number, serialized in whichever form it was authored.", + "oneOf": [ + { "type": "string" }, - "nullable": { - "description": "Whether the data in the given column can be null.", - "type": "boolean" - }, - "type": { - "description": "The column type.", - "type": "string" + { + "type": "number" } - }, + ], "type": "object" }, - "CsvManifestBody": { - "description": "Body of the CSV manifest.", - "properties": { - "column_date_formats": { - "additionalProperties": { - "description": "Map of column names to date formats to use when parsing them as dates.", - "type": "string" + "ConditionalFormattingLiteralRangeValue": { + "allOf": [ + { + "properties": { + "from": { + "format": "double", + "type": "number" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "literalRange" + ], + "type": "string" + }, + "to": { + "format": "double", + "type": "number" + } }, - "description": "Map of column names to date formats to use when parsing them as dates.", "type": "object" + } + ], + "description": "An inclusive numeric range.", + "properties": { + "from": { + "format": "double", + "type": "number" }, - "convert": { - "$ref": "#/components/schemas/CsvConvertOptions" - }, - "parse": { - "$ref": "#/components/schemas/CsvParseOptions" - }, - "read": { - "$ref": "#/components/schemas/CsvReadOptions" - }, - "read_method": { - "description": "Method used to read the CSV file.", + "kind": { + "description": "The value kind.", + "enum": [ + "literalRange" + ], "type": "string" + }, + "to": { + "format": "double", + "type": "number" } }, + "required": [ + "from", + "kind", + "to" + ], "type": "object" }, - "CsvParseOptions": { - "description": "Options for parsing CSV files.", + "ConditionalFormattingLiteralValue": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "literal" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingLiteral" + } + }, + "type": "object" + } + ], + "description": "A single value compared against the cell value.", "properties": { - "delimiter": { - "description": "The character delimiting individual cells in the CSV data.", + "kind": { + "description": "The value kind.", + "enum": [ + "literal" + ], "type": "string" }, - "doubleQuote": { - "description": "Whether two quotes in a quoted CSV value denote a single quote in the data.", + "value": { + "$ref": "#/components/schemas/ConditionalFormattingLiteral" + } + }, + "required": [ + "kind", + "value" + ], + "type": "object" + }, + "ConditionalFormattingMeasureTarget": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The target kind.", + "enum": [ + "measure" + ], + "type": "string" + }, + "measureIdentifier": { + "example": "8cd55fe5748b48d7820ae9ee18e58011", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A measure column, addressed by its bucket item local identifier.", + "properties": { + "kind": { + "description": "The target kind.", + "enum": [ + "measure" + ], + "type": "string" + }, + "measureIdentifier": { + "example": "8cd55fe5748b48d7820ae9ee18e58011", + "type": "string" + } + }, + "required": [ + "kind", + "measureIdentifier" + ], + "type": "object" + }, + "ConditionalFormattingNoneValue": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "No value; used by operators that take none.", + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "ConditionalFormattingRelativeDateValue": { + "allOf": [ + { + "properties": { + "from": { + "description": "Offset in periods; 0 is the current period, negative is the past.", + "example": -29, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Granularity the offsets are counted in.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "relativeDate" + ], + "type": "string" + }, + "to": { + "description": "Offset in periods, not lower than `from`.", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "description": "A date period relative to the moment of evaluation, resolved at render time.", + "properties": { + "from": { + "description": "Offset in periods; 0 is the current period, negative is the past.", + "example": -29, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Granularity the offsets are counted in.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "relativeDate" + ], + "type": "string" + }, + "to": { + "description": "Offset in periods, not lower than `from`.", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "from", + "granularity", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingRule": { + "description": "Conditions applied to a single column.", + "properties": { + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "bb955b38-a9e6-45f5-b068-155cb7ce509a", + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/ConditionalFormattingTarget" + } + }, + "required": [ + "conditions", + "target" + ], + "type": "object" + }, + "ConditionalFormattingTarget": { + "description": "Column a rule formats. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingAttributeTarget" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingMeasureTarget" + } + ], + "type": "object" + }, + "ConditionalFormattingValue": { + "description": "Value a condition compares against. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingNoneValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralRangeValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingAbsoluteDateValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingRelativeDateValue" + } + ], + "type": "object" + }, + "ContentSlideTemplate": { + "description": "Settings for content slide.", + "nullable": true, + "properties": { + "descriptionField": { + "example": "{{dashboardFilters}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, + "ConvertGeoFileRequest": { + "description": "Request to convert a geo file to GeoParquet format.", + "properties": { + "location": { + "description": "Location of the file in the staging area to convert.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "location" + ], + "type": "object" + }, + "ConvertGeoFileResponse": { + "description": "Response after successfully converting a geo file.", + "properties": { + "location": { + "description": "Location of the converted GeoParquet file in the staging area.", + "type": "string" + } + }, + "required": [ + "location" + ], + "type": "object" + }, + "CoverSlideTemplate": { + "description": "Settings for cover slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "descriptionField": { + "example": "Exported at: {{exportedAt}}", + "nullable": true, + "type": "string" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, + "CsvConvertOptions": { + "description": "Options for converting CSV files when reading.", + "properties": { + "autoDictEncode": { + "description": "Whether to try to automatically dict-encode string / binary data.", + "type": "boolean" + }, + "autoDictMaxCardinality": { + "description": "The maximum dictionary cardinality for autoDictEncode.", + "format": "int32", + "type": "integer" + }, + "checkUtf8": { + "description": "Whether to check UTF8 validity of string columns.", + "type": "boolean" + }, + "columnTypes": { + "description": "Information about the column types in the table.", + "items": { + "$ref": "#/components/schemas/CsvConvertOptionsColumnType" + }, + "type": "array" + }, + "decimalPoint": { + "description": "The character used as decimal point in floating-point and decimal data.", + "type": "string" + }, + "falseValues": { + "description": "Sequence of strings that denote false Booleans in the data.", + "items": { + "description": "Sequence of strings that denote false Booleans in the data.", + "type": "string" + }, + "type": "array" + }, + "includeColumns": { + "description": "The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.", + "items": { + "description": "The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.", + "type": "string" + }, + "type": "array" + }, + "includeMissingColumns": { + "description": "If false, columns in includeColumns but not in the CSV file will error out.", + "type": "boolean" + }, + "nullValues": { + "description": "Sequence of strings that denote nulls in the data.", + "items": { + "description": "Sequence of strings that denote nulls in the data.", + "type": "string" + }, + "type": "array" + }, + "quotedStringsCanBeNull": { + "description": "Whether quoted values can be null.", + "type": "boolean" + }, + "stringsCanBeNull": { + "description": "Whether string / binary columns can have null values.", + "type": "boolean" + }, + "timestampParsers": { + "description": "Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.", + "items": { + "description": "Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.", + "type": "string" + }, + "type": "array" + }, + "trueValues": { + "description": "Sequence of strings that denote true Booleans in the data.", + "items": { + "description": "Sequence of strings that denote true Booleans in the data.", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CsvConvertOptionsColumnType": { + "description": "Information about a certain column in the table.", + "properties": { + "name": { + "description": "The column name.", + "type": "string" + }, + "nullable": { + "description": "Whether the data in the given column can be null.", + "type": "boolean" + }, + "type": { + "description": "The column type.", + "type": "string" + } + }, + "type": "object" + }, + "CsvManifestBody": { + "description": "Body of the CSV manifest.", + "properties": { + "column_date_formats": { + "additionalProperties": { + "description": "Map of column names to date formats to use when parsing them as dates.", + "type": "string" + }, + "description": "Map of column names to date formats to use when parsing them as dates.", + "type": "object" + }, + "convert": { + "$ref": "#/components/schemas/CsvConvertOptions" + }, + "parse": { + "$ref": "#/components/schemas/CsvParseOptions" + }, + "read": { + "$ref": "#/components/schemas/CsvReadOptions" + }, + "read_method": { + "description": "Method used to read the CSV file.", + "type": "string" + } + }, + "type": "object" + }, + "CsvParseOptions": { + "description": "Options for parsing CSV files.", + "properties": { + "delimiter": { + "description": "The character delimiting individual cells in the CSV data.", + "type": "string" + }, + "doubleQuote": { + "description": "Whether two quotes in a quoted CSV value denote a single quote in the data.", "type": "boolean" }, "escapeChar": { @@ -4497,27 +4316,6 @@ ], "type": "object" }, - "DashboardContext": { - "description": "Dashboard the user is currently viewing.", - "properties": { - "id": { - "description": "Dashboard object ID.", - "type": "string" - }, - "widgets": { - "description": "Widgets currently visible on the dashboard.", - "items": { - "$ref": "#/components/schemas/WidgetDescriptor" - }, - "type": "array" - } - }, - "required": [ - "id", - "widgets" - ], - "type": "object" - }, "DashboardDateFilter": { "properties": { "dateFilter": { @@ -5317,33 +5115,6 @@ ], "type": "object" }, - "DateAbsoluteFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "from": { - "type": "string" - }, - "to": { - "type": "string" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "from", - "to", - "using" - ], - "type": "object" - }, "DateFilter": { "description": "Abstract filter definition type for dates.", "oneOf": [ @@ -5362,118 +5133,6 @@ ], "type": "object" }, - "DateRelativeFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "from": { - "format": "int32", - "type": "integer" - }, - "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" - }, - "to": { - "format": "int32", - "type": "integer" - }, - "using": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "from", - "granularity", - "to", - "using" - ], - "type": "object" - }, - "DateTruncPartitionConfig": { - "description": "Partition by date_trunc() expression.", - "properties": { - "column": { - "description": "Column to partition on.", - "type": "string" - }, - "type": { - "enum": [ - "dateTrunc" - ], - "type": "string" - }, - "unit": { - "description": "Date/time unit for partition granularity", - "enum": [ - "year", - "quarter", - "month", - "week", - "day", - "hour", - "minute", - "second", - "millisecond", - "microsecond" - ], - "type": "string" - } - }, - "required": [ - "column", - "type", - "unit" - ], - "type": "object" - }, "DateValue": { "properties": { "value": { @@ -5521,7 +5180,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -5543,6 +5205,14 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "$ref": "#/components/schemas/Instruction" + }, + "nullable": true, + "type": "array" + }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", @@ -5917,6 +5587,13 @@ }, "type": "array" }, + "computedAttributes": { + "description": "A list of computed attributes available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeComputedAttribute" + }, + "type": "array" + }, "dashboardPlugins": { "description": "A list of dashboard plugins available in the model.", "items": { @@ -5959,6 +5636,27 @@ }, "type": "array" }, + "reportPageLayouts": { + "description": "A list of report page layouts available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeReportPageLayout" + }, + "type": "array" + }, + "reportTemplates": { + "description": "A list of report templates available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeReportTemplate" + }, + "type": "array" + }, + "reports": { + "description": "A list of reports available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeReport" + }, + "type": "array" + }, "visualizationObjects": { "description": "A list of visualization objects available in the model.", "items": { @@ -5972,6 +5670,9 @@ "DeclarativeAttribute": { "description": "A dataset attribute.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "defaultView": { "$ref": "#/components/schemas/LabelIdentifier" }, @@ -6413,6 +6114,171 @@ ], "type": "object" }, + "DeclarativeComputedAttribute": { + "properties": { + "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.", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "certifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, + "content": { + "$ref": "#/components/schemas/DeclarativeComputedAttributeContent" + }, + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "createdBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, + "dataType": { + "description": "Computed attribute data type", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "example": "STRING", + "maxLength": 255, + "type": "string" + }, + "description": { + "description": "Computed attribute description.", + "example": "Sales for all the data available.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Computed attribute ID.", + "example": "total-sales", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "isHidden": { + "description": "If true, this computed attribute is hidden from AI search results.", + "example": false, + "type": "boolean" + }, + "isNullable": { + "description": "Flag indicating whether the associated source column allows null values.", + "example": false, + "type": "boolean" + }, + "locale": { + "description": "Default locale for primary computed label.", + "example": "en-US", + "type": "string" + }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, + "nullValue": { + "description": "Value used in coalesce during joins instead of null.", + "example": "empty_value", + "type": "string" + }, + "tags": { + "description": "A list of tags.", + "example": [ + "Revenues" + ], + "items": { + "description": "A list of tags.", + "example": "[\"Revenues\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Computed attribute title.", + "example": "Total sales", + "maxLength": 255, + "type": "string" + }, + "valueType": { + "description": "Specific type of the computed attribute value", + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" + } + }, + "required": [ + "content", + "id", + "title" + ], + "type": "object" + }, + "DeclarativeComputedAttributeContent": { + "description": "A definition of the computed attribute content.", + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "example": "%0.2f", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "example": "SELECT 1", + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, "DeclarativeCspDirective": { "properties": { "directive": { @@ -6626,6 +6492,11 @@ }, "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" + }, "id": { "description": "Data source ID.", "example": "pg_local_docker-demo", @@ -6709,7 +6580,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "example": "POSTGRESQL", "type": "string" @@ -6944,6 +6816,9 @@ "DeclarativeDateDataset": { "description": "A date dataset.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "description": { "description": "Date dataset description.", "example": "A customer order date", @@ -7527,6 +7402,9 @@ "DeclarativeLabel": { "description": "A attribute label.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "description": { "description": "Label description.", "example": "Customer name", @@ -7800,6 +7678,9 @@ "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "content": { "$ref": "#/components/schemas/JsonNode" }, @@ -8356,6 +8237,142 @@ ], "type": "object" }, + "DeclarativeReport": { + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "description": "Report description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Report ID.", + "example": "quarterly-review-2026-h1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "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": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Report title.", + "maxLength": 255, + "type": "string" + }, + "variableValues": { + "additionalProperties": { + "description": "Values for the variables declared in the content, keyed by name.", + "type": "string" + }, + "description": "Values for the variables declared in the content, keyed by name.", + "type": "object" + } + }, + "required": [ + "content", + "id", + "periodEnd", + "periodStart", + "title" + ], + "type": "object" + }, + "DeclarativeReportPageLayout": { + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "description": "Report page layout description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Report page layout 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": "Report page layout title.", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "title" + ], + "type": "object" + }, + "DeclarativeReportTemplate": { + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "description": "Report template description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Report template ID.", + "example": "quarterly-review-template", + "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": "Report template title.", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "title" + ], + "type": "object" + }, "DeclarativeRsaSpecification": { "description": "Declarative specification of the cryptographic key.", "properties": { @@ -8477,10 +8494,12 @@ "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", @@ -8488,7 +8507,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "example": "TIMEZONE", "type": "string" @@ -8518,6 +8542,7 @@ "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", "CREATE_VISUALIZATION", "CREATE_COMPUTED_ATTRIBUTE", "VIEW" @@ -8999,6 +9024,9 @@ "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "conditionalFormatting": { + "$ref": "#/components/schemas/ConditionalFormatting" + }, "content": { "$ref": "#/components/schemas/JsonNode" }, @@ -9436,6 +9464,7 @@ "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", "CREATE_VISUALIZATION", "CREATE_COMPUTED_ATTRIBUTE", "VIEW" @@ -9636,6 +9665,7 @@ "fact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "automation", @@ -9705,6 +9735,14 @@ "description": "Specifies on which label the filter depends on.", "type": "string" }, + "type": { + "description": "Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.", + "enum": [ + "label", + "computedAttribute" + ], + "type": "string" + }, "values": { "description": "Specifies values of the label for element filtering.", "items": { @@ -9768,34 +9806,6 @@ ], "type": "object" }, - "DimAttribute": { - "description": "List of attributes representing the dimensionality of the new visualization", - "properties": { - "id": { - "description": "ID of the object", - "example": "country", - "type": "string" - }, - "title": { - "description": "Title of attribute.", - "type": "string" - }, - "type": { - "description": "Object type", - "enum": [ - "attribute" - ], - "example": "attribute", - "type": "string" - } - }, - "required": [ - "id", - "title", - "type" - ], - "type": "object" - }, "Dimension": { "description": "Single dimension description.", "properties": { @@ -9845,48 +9855,6 @@ ], "type": "object" }, - "DistributionConfig": { - "description": "Distribution configuration for the OLAP table.", - "discriminator": { - "mapping": { - "hash": "#/components/schemas/HashDistributionConfig", - "random": "#/components/schemas/RandomDistributionConfig" - }, - "propertyName": "type" - }, - "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, - "DuplicateKeyConfig": { - "description": "Duplicate key model — allows duplicate rows for the given key columns.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "duplicate" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "Element": { "description": "List of returned elements.", "properties": { @@ -9979,6 +9947,14 @@ "example": "Europe/Prague", "type": "string" }, + "type": { + "description": "Type of the object ```label``` refers to. A set type is taken at its word; an unset one means a label, with a computed attribute of the same id accepted as a fallback.", + "enum": [ + "label", + "computedAttribute" + ], + "type": "string" + }, "validateBy": { "description": "Return only items that are computable on metric.", "items": { @@ -10138,6 +10114,7 @@ "fact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "automation", @@ -10242,27 +10219,6 @@ ], "type": "object" }, - "ErrorInfo": { - "description": "Structured error, present when the search could not run (e.g. metadata sync in progress). Absent on success.", - "properties": { - "reason": { - "description": "Stable machine-readable error code. Switch on this for localized client messages.", - "example": "METADATA_SYNC_IN_PROGRESS", - "type": "string" - }, - "statusCode": { - "description": "HTTP-like semantic status (e.g. 503 when the workspace is still syncing).", - "example": 503, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "reason", - "statusCode" - ], - "type": "object" - }, "ExecutionLinks": { "description": "Links to the execution result.", "properties": { @@ -10874,8 +10830,35 @@ "namespace": "urn:oasis:names:tc:xliff:document:2.0" } }, - "Filter": { - "description": "List of filters to be applied to the new visualization", + "FileFlowInput": { + "allOf": [ + { + "properties": { + "dataSourceId": { + "description": "Identifier of the GDSTORAGE data source.", + "type": "string" + }, + "table": { + "description": "Name of the table in the data source.", + "type": "string" + }, + "type": { + "description": "Type of the input.", + "enum": [ + "file" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Reads the latest version of a table uploaded to a GDSTORAGE data source.", + "required": [ + "dataSourceId", + "table", + "type" + ], "type": "object" }, "FilterBy": { @@ -10976,28 +10959,304 @@ ], "type": "object" }, - "ForecastConfig": { - "description": "Forecast configuration.", + "FlowColumn": { + "description": "A column of a flow result.", "properties": { - "confidenceLevel": { - "description": "Confidence interval boundary value.", - "format": "float", - "type": "number" + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Metadata of the column, as the operation that produced it gives them.", + "type": "object" }, - "forecastPeriod": { - "description": "Number of future periods that should be forecasted", + "name": { + "description": "Name of the column.", + "type": "string" + }, + "type": { + "description": "Type of the values in the column.", + "example": "double", + "type": "string" + } + }, + "required": [ + "metadata", + "name", + "type" + ], + "type": "object" + }, + "FlowExecutionResponse": { + "description": "A submitted flow: where to read its result.", + "properties": { + "links": { + "$ref": "#/components/schemas/ExecutionLinks" + } + }, + "required": [ + "links" + ], + "type": "object" + }, + "FlowInput": { + "description": "An input of a flow.", + "oneOf": [ + { + "$ref": "#/components/schemas/FileFlowInput" + }, + { + "$ref": "#/components/schemas/AfmFlowInput" + }, + { + "$ref": "#/components/schemas/SqlFlowInput" + } + ], + "type": "object" + }, + "FlowOperationDescriptor": { + "description": "An operation that a transformation can run.", + "properties": { + "description": { + "description": "What the operation does.", + "type": "string" + }, + "inputs": { + "description": "Inputs of the operation. The first one is the primary input, named data.", + "items": { + "$ref": "#/components/schemas/FlowOperationInput" + }, + "type": "array" + }, + "name": { + "description": "Name of the operation. A transformation gives it as its operation.", + "type": "string" + }, + "output": { + "$ref": "#/components/schemas/FlowOperationOutput" + }, + "parameters": { + "additionalProperties": true, + "description": "JSON Schema of the parameters of the operation.", + "type": "object" + }, + "pure": { + "description": "True when the result depends only on the inputs and the parameters. The result of an impure operation is never reused.", + "type": "boolean" + } + }, + "required": [ + "description", + "inputs", + "name", + "output", + "parameters", + "pure" + ], + "type": "object" + }, + "FlowOperationInput": { + "description": "An input of an operation.", + "properties": { + "description": { + "description": "What the operation expects in the input.", + "type": "string" + }, + "name": { + "description": "Name of the input. A transformation binds it in its inputRefs.", + "type": "string" + } + }, + "required": [ + "description", + "name" + ], + "type": "object" + }, + "FlowOperationOutput": { + "description": "The output of an operation.", + "properties": { + "description": { + "description": "What the operation produces.", + "type": "string" + } + }, + "required": [ + "description" + ], + "type": "object" + }, + "FlowOperations": { + "description": "The operations that the transformations of a flow can run.", + "properties": { + "operations": { + "description": "Available operations.", + "items": { + "$ref": "#/components/schemas/FlowOperationDescriptor" + }, + "type": "array" + } + }, + "required": [ + "operations" + ], + "type": "object" + }, + "FlowRequest": { + "description": "A flow: named inputs and the transformations that run over them.", + "properties": { + "inputs": { + "additionalProperties": { + "$ref": "#/components/schemas/FlowInput" + }, + "description": "Inputs of the flow by name. A transformation refers to an input by its name.", + "type": "object" + }, + "transformations": { + "description": "Transformations in the order they run. The result of the last transformation is the result of the flow. Without transformations, the result is the only input.", + "items": { + "$ref": "#/components/schemas/FlowTransformation" + }, + "type": "array" + } + }, + "required": [ + "inputs" + ], + "type": "object" + }, + "FlowResultMetadata": { + "description": "Description of a flow result.", + "properties": { + "columns": { + "description": "Columns of the result, in order.", + "items": { + "$ref": "#/components/schemas/FlowColumn" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Metadata of the result, as the operations that produced it give them.", + "type": "object" + }, + "totalRows": { + "description": "Number of rows in the result.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "columns", + "metadata", + "totalRows" + ], + "type": "object" + }, + "FlowTablePaging": { + "description": "Position of a page in a table result.", + "properties": { + "columnLimit": { + "description": "Maximum number of columns in the page.", "format": "int32", "type": "integer" }, - "seasonal": { - "description": "Whether the input data is seasonal", - "type": "boolean" + "columnOffset": { + "description": "Index of the first column of the page.", + "format": "int32", + "type": "integer" + }, + "rowLimit": { + "description": "Maximum number of rows in the page.", + "format": "int32", + "type": "integer" + }, + "rowOffset": { + "description": "Index of the first row of the page.", + "format": "int32", + "type": "integer" + }, + "totalColumns": { + "description": "Number of columns in the result.", + "format": "int32", + "type": "integer" + }, + "totalRows": { + "description": "Number of rows in the result.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "columnLimit", + "columnOffset", + "rowLimit", + "rowOffset", + "totalColumns", + "totalRows" + ], + "type": "object" + }, + "FlowTableResult": { + "description": "A page of a table result.", + "properties": { + "columns": { + "description": "Columns of the page, in order.", + "items": { + "$ref": "#/components/schemas/FlowColumn" + }, + "type": "array" + }, + "data": { + "description": "Rows of the page. A row has one value for each column, in the order of the columns.", + "items": { + "items": { + "type": "object" + }, + "type": "array" + }, + "type": "array" + }, + "paging": { + "$ref": "#/components/schemas/FlowTablePaging" + } + }, + "required": [ + "columns", + "data", + "paging" + ], + "type": "object" + }, + "FlowTransformation": { + "description": "One transformation of a flow: an operation that runs over its inputs.", + "properties": { + "id": { + "description": "Identifier of the transformation. Give it when a later transformation refers to it. The identifier does not change the result.", + "nullable": true, + "type": "string" + }, + "inputRefs": { + "additionalProperties": { + "type": "string" + }, + "description": "Inputs of the operation by name. Each one refers to a flow input or to an earlier transformation. The primary input is named data. When data is not given, it refers to the previous transformation, or to the only flow input for the first transformation.", + "type": "object" + }, + "operation": { + "description": "Name of the operation, as the operation catalog lists it.", + "example": "survey_weighting", + "type": "string" + }, + "parameters": { + "additionalProperties": true, + "description": "Parameters of the operation. They must match the parameter schema of the operation.", + "type": "object" } }, "required": [ - "confidenceLevel", - "forecastPeriod", - "seasonal" + "operation" ], "type": "object" }, @@ -11075,28 +11334,6 @@ ], "type": "object" }, - "FoundObjects": { - "description": "List of objects found by similarity search and post-processed by LLM.", - "properties": { - "objects": { - "description": "List of objects found with a similarity search.", - "items": { - "$ref": "#/components/schemas/SearchResultObject" - }, - "type": "array" - }, - "reasoning": { - "deprecated": true, - "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", - "type": "string" - } - }, - "required": [ - "objects", - "reasoning" - ], - "type": "object" - }, "Frequency": { "properties": { "buckets": { @@ -11170,47 +11407,6 @@ ], "type": "object" }, - "GenAiRankingFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/Filter" - }, - { - "properties": { - "dimensionality": { - "items": { - "type": "string" - }, - "type": "array" - }, - "measures": { - "items": { - "type": "string" - }, - "type": "array" - }, - "operator": { - "enum": [ - "TOP", - "BOTTOM" - ], - "type": "string" - }, - "value": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - } - ], - "required": [ - "measures", - "operator", - "value" - ], - "type": "object" - }, "GenerateDescriptionRequest": { "properties": { "objectId": { @@ -11571,12 +11767,16 @@ "properties": { "level": { "description": "Level of permission", - "example": "VIEW, SHARE, EDIT", + "example": "VIEW", "type": "string" }, "source": { "description": "Source of permission", - "example": "direct/indirect", + "enum": [ + "direct", + "indirect" + ], + "example": "indirect", "type": "string" } }, @@ -11607,35 +11807,6 @@ ], "type": "object" }, - "HashDistributionConfig": { - "description": "Hash-based distribution across buckets.", - "properties": { - "buckets": { - "description": "Number of hash buckets. Defaults to 1.", - "format": "int32", - "minimum": 1, - "type": "integer" - }, - "columns": { - "description": "Columns to distribute by. Defaults to first column.", - "items": { - "description": "Columns to distribute by. Defaults to first column.", - "type": "string" - }, - "type": "array" - }, - "type": { - "enum": [ - "hash" - ], - "type": "string" - } - }, - "required": [ - "type" - ], - "type": "object" - }, "HeaderGroup": { "description": "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", "properties": { @@ -11787,6 +11958,7 @@ "aggregatedFact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "exportDefinition", @@ -11802,6 +11974,9 @@ "workspaceDataFilter", "workspaceDataFilterSetting", "filterView", + "reportPageLayout", + "reportTemplate", + "report", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -12087,44 +12262,38 @@ ], "type": "object" }, - "InsightWidgetDescriptor": { - "description": "Insight widget displaying a visualization.", + "Instruction": { + "description": "Rule that an agent follows when answering.", + "nullable": true, "properties": { - "filters": { - "description": "Filters currently applied to the dashboard.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" - }, - "resultId": { - "description": "Signed result ID for this widget's cached execution result.", - "type": "string" - }, - "title": { - "description": "Widget title as displayed on the dashboard.", - "type": "string" - }, - "visualizationId": { - "description": "Visualization object ID referenced by this insight widget.", + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, "type": "string" }, - "widgetId": { - "description": "Widget object ID.", - "type": "string" + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" }, - "widgetType": { + "strategy": { + "description": "When an instruction is applied to a request", "enum": [ - "insight" + "ALWAYS", + "AUTO" ], "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" } }, "required": [ - "title", - "visualizationId", - "widgetId", - "widgetType" + "content", + "strategy" ], "type": "object" }, @@ -12156,6 +12325,32 @@ }, "type": "object" }, + "Invitation": { + "properties": { + "email": { + "format": "email", + "type": "string" + }, + "firstName": { + "type": "string" + }, + "forceSend": { + "description": "Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends)", + "type": "boolean" + }, + "lastName": { + "type": "string" + }, + "userId": { + "type": "string" + } + }, + "required": [ + "email", + "userId" + ], + "type": "object" + }, "IpAllowlistPolicyTargets": { "description": "Target delta for IP allowlist policy actions.", "properties": { @@ -12196,7 +12391,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -12211,128 +12409,209 @@ "enabled": { "type": "boolean" }, - "isPreview": { - "type": "boolean" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "personality": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "skillsMode": { - "enum": [ - "all", - "custom" - ], - "type": "string" - } - }, - "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": [ - "agent" - ], - "example": "agent", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiAgentInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAgentIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiAgentOut": { - "description": "JSON:API representation of agent entity.", - "properties": { - "attributes": { - "properties": { - "aiKnowledge": { - "type": "boolean" - }, - "availableToAll": { - "type": "boolean" - }, - "createdAt": { - "format": "date-time", - "type": "string" - }, - "customSkills": { + "instructions": { + "description": "Rules this agent follows when answering.", "items": { - "enum": [ - "alert", - "anomaly_detection", - "clustering", - "forecasting", - "key_driver_analysis", - "metric", - "schedule_export", - "visualization", - "visualization_summary", - "dashboard_summary", - "what_if_analysis", - "knowledge" + "description": "Rule that an agent follows when answering.", + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" ], - "type": "string" + "type": "object" }, "nullable": true, "type": "array" }, - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "enabled": { - "type": "boolean" - }, "isPreview": { "type": "boolean" }, - "modifiedAt": { - "format": "date-time", - "type": "string" - }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "personality": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "skillsMode": { + "enum": [ + "all", + "custom" + ], + "type": "string" + } + }, + "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": [ + "agent" + ], + "example": "agent", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiAgentInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAgentIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiAgentOut": { + "description": "JSON:API representation of agent entity.", + "properties": { + "attributes": { + "properties": { + "aiKnowledge": { + "type": "boolean" + }, + "availableToAll": { + "type": "boolean" + }, + "createdAt": { + "format": "date-time", + "type": "string" + }, + "customSkills": { + "items": { + "enum": [ + "alert", + "anomaly_detection", + "clustering", + "forecasting", + "key_driver_analysis", + "metric", + "schedule_export", + "visualization", + "visualization_summary", + "dashboard_summary", + "what_if_analysis", + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "description": "Rule that an agent follows when answering.", + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "isPreview": { + "type": "boolean" + }, + "modifiedAt": { + "format": "date-time", + "type": "string" + }, "name": { "maxLength": 255, "nullable": true, @@ -12427,6 +12706,19 @@ }, "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": [ @@ -12469,6 +12761,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" @@ -12514,7 +12814,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -12529,6 +12832,45 @@ "enabled": { "type": "boolean" }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "description": "Rule that an agent follows when answering.", + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, "isPreview": { "type": "boolean" }, @@ -12776,6 +13118,19 @@ }, "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": [ @@ -12821,6 +13176,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" @@ -13104,6 +13467,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -13237,6 +13611,19 @@ }, "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": [ @@ -13249,6 +13636,9 @@ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" }, @@ -13300,6 +13690,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" @@ -13862,6 +14260,19 @@ }, "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": [ @@ -13904,6 +14315,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" @@ -14035,6 +14454,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this attribute.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -14165,6 +14606,18 @@ "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" @@ -14248,6 +14701,19 @@ }, "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": [ @@ -14293,6 +14759,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" @@ -14318,6 +14792,28 @@ "properties": { "attributes": { "properties": { + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this attribute.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -14423,6 +14919,9 @@ ], "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", @@ -14756,6 +15255,9 @@ ], "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", @@ -15026,6 +15528,28 @@ ], "type": "object" }, + "analyticalDashboards": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "attributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "automationResults": { "properties": { "data": { @@ -15037,6 +15561,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -15059,6 +15594,39 @@ ], "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": { @@ -15091,6 +15659,17 @@ "data" ], "type": "object" + }, + "visualizationObjects": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "type": "object" @@ -15125,6 +15704,19 @@ }, "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": [ @@ -15137,12 +15729,27 @@ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" }, @@ -15151,6 +15758,9 @@ }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" } ] }, @@ -15179,6 +15789,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" @@ -15223,6 +15841,9 @@ ], "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", @@ -15628,6 +16249,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" @@ -15862,21 +16491,97 @@ ], "type": "object" }, - "JsonApiCookieSecurityConfigurationIn": { - "description": "JSON:API representation of cookieSecurityConfiguration entity.", + "JsonApiComputedAttributeIn": { + "description": "JSON:API representation of computedAttribute entity.", "properties": { "attributes": { "properties": { - "lastRotation": { - "format": "date-time", + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], "type": "string" }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "type": "string" + }, + "nullValue": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], "type": "string" } }, + "required": [ + "content" + ], "type": "object" }, "id": { @@ -15888,22 +16593,23 @@ "type": { "description": "Object type", "enum": [ - "cookieSecurityConfiguration" + "computedAttribute" ], - "example": "cookieSecurityConfiguration", + "example": "computedAttribute", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiCookieSecurityConfigurationInDocument": { + "JsonApiComputedAttributeInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" + "$ref": "#/components/schemas/JsonApiComputedAttributeIn" } }, "required": [ @@ -15911,35 +16617,16 @@ ], "type": "object" }, - "JsonApiCookieSecurityConfigurationOut": { - "description": "JSON:API representation of cookieSecurityConfiguration entity.", + "JsonApiComputedAttributeLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { - "attributes": { - "properties": { - "lastRotation": { - "format": "date-time", - "type": "string" - }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", - "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": [ - "cookieSecurityConfiguration" + "computedAttribute" ], - "example": "cookieSecurityConfiguration", "type": "string" } }, @@ -15949,83 +16636,132 @@ ], "type": "object" }, - "JsonApiCookieSecurityConfigurationOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationPatch": { - "description": "JSON:API representation of patching cookieSecurityConfiguration entity.", + "JsonApiComputedAttributeOut": { + "description": "JSON:API representation of computedAttribute entity.", "properties": { "attributes": { "properties": { - "lastRotation": { + "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" }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", + "content": { + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "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" - } - }, - "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": [ - "cookieSecurityConfiguration" - ], - "example": "cookieSecurityConfiguration", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveIn": { - "description": "JSON:API representation of cspDirective entity.", - "properties": { - "attributes": { - "properties": { - "sources": { + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "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" + }, + "nullValue": { + "type": "string" + }, + "tags": { "items": { "type": "string" }, "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" } }, "required": [ - "sources" + "content" ], "type": "object" }, @@ -16035,103 +16771,271 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "cspDirective" - ], - "example": "cspDirective", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCspDirectiveInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveIn" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveOut": { - "description": "JSON:API representation of cspDirective entity.", - "properties": { - "attributes": { + "meta": { "properties": { - "sources": { + "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" } }, - "required": [ - "sources" - ], "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": [ - "cspDirective" - ], - "example": "cspDirective", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCspDirectiveOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveOutList": { - "description": "A JSON:API document with a list of resources", - "properties": { - "data": { - "items": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { + "relationships": { "properties": { - "page": { + "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": [ + "computedAttribute" + ], + "example": "computedAttribute", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiComputedAttributeOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOut" + }, + "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" + }, + "JsonApiComputedAttributeOutIncludes": { + "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/JsonApiUserIdentifierOutWithLinks" + } + ] + }, + "JsonApiComputedAttributeOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, + "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" @@ -16142,26 +17046,102 @@ ], "type": "object" }, - "JsonApiCspDirectiveOutWithLinks": { + "JsonApiComputedAttributeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + "$ref": "#/components/schemas/JsonApiComputedAttributeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiCspDirectivePatch": { - "description": "JSON:API representation of patching cspDirective entity.", + "JsonApiComputedAttributePatch": { + "description": "JSON:API representation of patching computedAttribute entity.", "properties": { "attributes": { "properties": { - "sources": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "type": "string" + }, + "nullValue": { + "type": "string" + }, + "tags": { "items": { "type": "string" }, "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" } }, "type": "object" @@ -16175,9 +17155,9 @@ "type": { "description": "Object type", "enum": [ - "cspDirective" + "computedAttribute" ], - "example": "cspDirective", + "example": "computedAttribute", "type": "string" } }, @@ -16188,10 +17168,10 @@ ], "type": "object" }, - "JsonApiCspDirectivePatchDocument": { + "JsonApiComputedAttributePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatch" + "$ref": "#/components/schemas/JsonApiComputedAttributePatch" } }, "required": [ @@ -16199,23 +17179,95 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingIn": { - "description": "JSON:API representation of customApplicationSetting entity.", + "JsonApiComputedAttributePostOptionalId": { + "description": "JSON:API representation of computedAttribute entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" + "areRelationsValid": { + "type": "boolean" }, "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], "type": "object" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "type": "string" + }, + "nullValue": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" } }, "required": [ - "applicationName", "content" ], "type": "object" @@ -16229,23 +17281,22 @@ "type": { "description": "Object type", "enum": [ - "customApplicationSetting" + "computedAttribute" ], - "example": "customApplicationSetting", + "example": "computedAttribute", "type": "string" } }, "required": [ "attributes", - "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingInDocument": { + "JsonApiComputedAttributePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalId" } }, "required": [ @@ -16253,25 +17304,28 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingOut": { - "description": "JSON:API representation of customApplicationSetting entity.", + "JsonApiComputedAttributeToManyLinkage": { + "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/JsonApiComputedAttributeLinkage" + }, + "type": "array" + }, + "JsonApiCookieSecurityConfigurationIn": { + "description": "JSON:API representation of cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, + "lastRotation": { + "format": "date-time", "type": "string" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, - "type": "object" + "rotationInterval": { + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D", + "type": "string" } }, - "required": [ - "applicationName", - "content" - ], "type": "object" }, "id": { @@ -16280,82 +17334,25 @@ "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": [ - "customApplicationSetting" + "cookieSecurityConfiguration" ], - "example": "customApplicationSetting", + "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingOutList": { - "description": "A JSON:API document with a list of resources", + "JsonApiCookieSecurityConfigurationInDocument": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" } }, "required": [ @@ -16363,29 +17360,19 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiCustomApplicationSettingPatch": { - "description": "JSON:API representation of patching customApplicationSetting entity.", + "JsonApiCookieSecurityConfigurationOut": { + "description": "JSON:API representation of cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, + "lastRotation": { + "format": "date-time", "type": "string" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, - "type": "object" + "rotationInterval": { + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D", + "type": "string" } }, "type": "object" @@ -16399,23 +17386,25 @@ "type": { "description": "Object type", "enum": [ - "customApplicationSetting" + "cookieSecurityConfiguration" ], - "example": "customApplicationSetting", + "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingPatchDocument": { + "JsonApiCookieSecurityConfigurationOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ @@ -16423,14 +17412,474 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingPostOptionalId": { - "description": "JSON:API representation of customApplicationSetting entity.", + "JsonApiCookieSecurityConfigurationPatch": { + "description": "JSON:API representation of patching cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" + "lastRotation": { + "format": "date-time", + "type": "string" + }, + "rotationInterval": { + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D", + "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": [ + "cookieSecurityConfiguration" + ], + "example": "cookieSecurityConfiguration", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiCookieSecurityConfigurationPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCspDirectiveIn": { + "description": "JSON:API representation of cspDirective entity.", + "properties": { + "attributes": { + "properties": { + "sources": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "sources" + ], + "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": [ + "cspDirective" + ], + "example": "cspDirective", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCspDirectiveInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCspDirectiveIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCspDirectiveOut": { + "description": "JSON:API representation of cspDirective entity.", + "properties": { + "attributes": { + "properties": { + "sources": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "sources" + ], + "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": [ + "cspDirective" + ], + "example": "cspDirective", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCspDirectiveOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCspDirectiveOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCspDirectiveOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiCspDirectivePatch": { + "description": "JSON:API representation of patching cspDirective entity.", + "properties": { + "attributes": { + "properties": { + "sources": { + "items": { + "type": "string" + }, + "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": [ + "cspDirective" + ], + "example": "cspDirective", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCspDirectivePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCspDirectivePatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingIn": { + "description": "JSON:API representation of customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "type": "object" + } + }, + "required": [ + "applicationName", + "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": [ + "customApplicationSetting" + ], + "example": "customApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOut": { + "description": "JSON:API representation of customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "type": "object" + } + }, + "required": [ + "applicationName", + "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" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "customApplicationSetting" + ], + "example": "customApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiCustomApplicationSettingPatch": { + "description": "JSON:API representation of patching customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "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": [ + "customApplicationSetting" + ], + "example": "customApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingPostOptionalId": { + "description": "JSON:API representation of customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", @@ -17105,6 +18554,19 @@ }, "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": [ @@ -17137,6 +18599,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" @@ -17332,7 +18802,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" } @@ -17502,6 +18973,11 @@ "nullable": true, "type": "string" }, + "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" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -17585,7 +19061,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" }, @@ -17725,6 +19202,11 @@ "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" @@ -17788,7 +19270,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" }, @@ -17970,6 +19453,11 @@ "nullable": true, "type": "string" }, + "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" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -18053,7 +19541,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" }, @@ -18447,6 +19936,19 @@ }, "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": [ @@ -18498,6 +20000,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" @@ -18604,22 +20114,6 @@ ], "type": "object" }, - "JsonApiDocumentPipeTable": { - "description": "JSON:API-compatible single-resource response envelope", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiItemPipeTable" - }, - "links": { - "$ref": "#/components/schemas/JsonApiListLinks" - } - }, - "required": [ - "data", - "links" - ], - "type": "object" - }, "JsonApiEntitlementOut": { "description": "JSON:API representation of entitlement entity.", "properties": { @@ -18998,6 +20492,19 @@ }, "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": [ @@ -19046,6 +20553,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" @@ -19862,6 +21377,18 @@ "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" @@ -19912,6 +21439,19 @@ }, "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": [ @@ -19944,6 +21484,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" @@ -20209,6 +21757,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "datasets": { "properties": { "data": { @@ -20220,6 +21779,17 @@ ], "type": "object" }, + "facts": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "labels": { "properties": { "data": { @@ -20230,6 +21800,17 @@ "data" ], "type": "object" + }, + "metrics": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "type": "object" @@ -20265,6 +21846,19 @@ }, "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": [ @@ -20277,11 +21871,20 @@ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" } ] }, @@ -20310,6 +21913,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" @@ -20675,6 +22286,19 @@ }, "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": [ @@ -20717,6 +22341,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" @@ -21588,6 +23220,19 @@ }, "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": [ @@ -21630,6 +23275,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" @@ -21716,50 +23369,6 @@ ], "type": "object" }, - "JsonApiItemPipeTable": { - "description": "A single JSON:API resource item", - "properties": { - "attributes": { - "$ref": "#/components/schemas/PipeTable" - }, - "id": { - "description": "Resource identifier", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiItemPipeTableSummary": { - "description": "A single JSON:API resource item", - "properties": { - "attributes": { - "$ref": "#/components/schemas/PipeTableSummary" - }, - "id": { - "description": "Resource identifier", - "type": "string" - }, - "type": { - "description": "Resource type", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, "JsonApiItemServiceInfo": { "description": "A single JSON:API resource item", "properties": { @@ -22362,6 +23971,19 @@ }, "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": [ @@ -22404,6 +24026,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" @@ -22790,6 +24420,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -22911,6 +24563,18 @@ "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" @@ -22961,6 +24625,19 @@ }, "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": [ @@ -22993,6 +24670,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" @@ -23018,6 +24703,28 @@ "properties": { "attributes": { "properties": { + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -23152,29 +24859,6 @@ ], "type": "object" }, - "JsonApiListDocumentPipeTableSummary": { - "description": "JSON:API-compatible list response envelope", - "properties": { - "data": { - "description": "Array of resource items", - "items": { - "$ref": "#/components/schemas/JsonApiItemPipeTableSummary" - }, - "type": "array" - }, - "links": { - "$ref": "#/components/schemas/JsonApiListLinks" - }, - "meta": { - "$ref": "#/components/schemas/JsonApiListMeta" - } - }, - "required": [ - "data", - "links" - ], - "type": "object" - }, "JsonApiListDocumentServiceInfo": { "description": "JSON:API-compatible list response envelope", "properties": { @@ -23838,6 +25522,19 @@ }, "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": [ @@ -23870,6 +25567,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" @@ -24065,6 +25770,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -24197,6 +25924,28 @@ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -24293,6 +26042,18 @@ "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" @@ -24321,6 +26082,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -24425,13 +26197,26 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$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": [ @@ -24439,31 +26224,6 @@ ], "type": "object" }, - "JsonApiMetricOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - } - ] - }, "JsonApiMetricOutList": { "description": "A JSON:API document with a list of resources", "properties": { @@ -24477,7 +26237,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" }, "type": "array", "uniqueItems": true @@ -24489,6 +26249,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" @@ -24517,6 +26285,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -24607,6 +26397,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -25509,6 +27321,19 @@ }, "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": [ @@ -25541,6 +27366,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" @@ -25880,6 +27713,19 @@ }, "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": [ @@ -26040,10 +27886,12 @@ "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", @@ -26051,7 +27899,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" } @@ -26143,10 +27996,12 @@ "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", @@ -26154,7 +28009,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" } @@ -26286,10 +28146,12 @@ "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", @@ -26297,7 +28159,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" } @@ -26616,6 +28483,19 @@ }, "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": [ @@ -26648,6 +28528,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" @@ -26829,24 +28717,313 @@ }, "type": "array" }, - "JsonApiThemeIn": { - "description": "JSON:API representation of theme entity.", + "JsonApiReportIn": { + "description": "JSON:API representation of report entity.", "properties": { "attributes": { "properties": { + "areRelationsValid": { + "type": "boolean" + }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "name": { + "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", - "name" + "periodEnd", + "periodStart", + "title" ], "type": "object" }, @@ -26859,9 +29036,9 @@ "type": { "description": "Object type", "enum": [ - "theme" + "report" ], - "example": "theme", + "example": "report", "type": "string" } }, @@ -26872,10 +29049,10 @@ ], "type": "object" }, - "JsonApiThemeInDocument": { + "JsonApiReportInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiThemeIn" + "$ref": "#/components/schemas/JsonApiReportIn" } }, "required": [ @@ -26883,24 +29060,329 @@ ], "type": "object" }, - "JsonApiThemeOut": { - "description": "JSON:API representation of theme entity.", + "JsonApiReportOut": { + "description": "JSON:API representation of report entity.", "properties": { "attributes": { "properties": { + "areRelationsValid": { + "type": "boolean" + }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "name": { + "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" + }, + "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", - "name" + "periodEnd", + "periodStart", + "title" ], "type": "object" }, @@ -26910,12 +29392,65 @@ "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": [ - "theme" + "report" ], - "example": "theme", + "example": "report", "type": "string" } }, @@ -26926,13 +29461,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": [ @@ -26940,12 +29496,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 @@ -26957,6 +29521,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" @@ -26967,95 +29539,171 @@ ], "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": { - "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": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" } }, "required": [ - "maql" + "content", + "title" ], "type": "object" }, @@ -27065,39 +29713,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" } }, @@ -27108,10 +29729,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterInDocument": { + "JsonApiReportPageLayoutInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + "$ref": "#/components/schemas/JsonApiReportPageLayoutIn" } }, "required": [ @@ -27119,20 +29740,161 @@ ], "type": "object" }, - "JsonApiUserDataFilterOut": { - "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": { @@ -27147,7 +29909,8 @@ } }, "required": [ - "maql" + "content", + "title" ], "type": "object" }, @@ -27185,76 +29948,10 @@ }, "relationships": { "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "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": [ @@ -27262,10 +29959,10 @@ ], "type": "object" }, - "userGroup": { + "modifiedBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -27279,9 +29976,9 @@ "type": { "description": "Object type", "enum": [ - "userDataFilter" + "reportPageLayout" ], - "example": "userDataFilter", + "example": "reportPageLayout", "type": "string" } }, @@ -27292,21 +29989,34 @@ ], "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 }, "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": [ @@ -27314,40 +30024,12 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$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 @@ -27355,7 +30037,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -27367,6 +30049,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" @@ -27377,29 +30067,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" }, @@ -27422,39 +30237,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" } }, @@ -27465,10 +30253,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterPatchDocument": { + "JsonApiReportPageLayoutPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatch" } }, "required": [ @@ -27476,19 +30264,144 @@ ], "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" + "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" }, @@ -27504,7 +30417,8 @@ } }, "required": [ - "maql" + "content", + "title" ], "type": "object" }, @@ -27514,39 +30428,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" } }, @@ -27556,10 +30443,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterPostOptionalIdDocument": { + "JsonApiReportPageLayoutPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalId" } }, "required": [ @@ -27567,93 +30454,306 @@ ], "type": "object" }, - "JsonApiUserGroupIn": { - "description": "JSON:API representation of userGroup entity.", + "JsonApiReportPatch": { + "description": "JSON:API representation of patching report 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": { + "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" @@ -27664,87 +30764,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" }, - "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" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiUserGroupOutList": { - "description": "A JSON:API document with a list of resources", + "JsonApiReportPatchDocument": { "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" - } - }, - "type": "object" + "$ref": "#/components/schemas/JsonApiReportPatch" } }, "required": [ @@ -27752,26 +30791,314 @@ ], "type": "object" }, - "JsonApiUserGroupOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserGroupOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiUserGroupPatch": { - "description": "JSON:API representation of patching userGroup entity.", + "JsonApiReportPostOptionalId": { + "description": "JSON:API representation of 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" + } } }, + "required": [ + "content", + "periodEnd", + "periodStart", + "title" + ], "type": "object" }, "id": { @@ -27780,41 +31107,25 @@ "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": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiUserGroupPatchDocument": { + "JsonApiReportPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupPatch" + "$ref": "#/components/schemas/JsonApiReportPostOptionalId" } }, "required": [ @@ -27822,59 +31133,275 @@ ], "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.", + "JsonApiReportTemplateIn": { + "description": "JSON:API representation of reportTemplate entity.", "properties": { "attributes": { "properties": { - "email": { - "maxLength": 255, - "type": "string" + "areRelationsValid": { + "type": "boolean" }, - "firstname": { - "maxLength": 255, + "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" }, - "lastname": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "title" + ], "type": "object" }, "id": { @@ -27886,52 +31413,23 @@ "type": { "description": "Object type", "enum": [ - "userIdentifier" + "reportTemplate" ], - "example": "userIdentifier", + "example": "reportTemplate", "type": "string" } }, "required": [ + "attributes", "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", + "JsonApiReportTemplateInDocument": { "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/JsonApiReportTemplateIn" } }, "required": [ @@ -27939,148 +31437,291 @@ ], "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.", + "JsonApiReportTemplateOut": { + "description": "JSON:API representation of reportTemplate 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, + "areRelationsValid": { "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" - } + }, + "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" }, - "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, + }, + "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" }, - "email": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "firstname": { - "maxLength": 255, + "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" }, - "lastname": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, + "required": [ + "content", + "title" + ], "type": "object" }, "id": { @@ -28089,12 +31730,49 @@ "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": { + "createdBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -28108,33 +31786,47 @@ "type": { "description": "Object type", "enum": [ - "user" + "reportTemplate" ], - "example": "user", + "example": "reportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserOutDocument": { + "JsonApiReportTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiReportTemplateOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$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": [ @@ -28142,12 +31834,12 @@ ], "type": "object" }, - "JsonApiUserOutList": { + "JsonApiReportTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportTemplateOutWithLinks" }, "type": "array", "uniqueItems": true @@ -28155,7 +31847,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -28167,6 +31859,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" @@ -28177,41 +31877,279 @@ ], "type": "object" }, - "JsonApiUserOutWithLinks": { + "JsonApiReportTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiReportTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserPatch": { - "description": "JSON:API representation of patching user entity.", + "JsonApiReportTemplatePatch": { + "description": "JSON:API representation of patching reportTemplate entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" + "areRelationsValid": { + "type": "boolean" }, - "email": { - "maxLength": 255, - "type": "string" + "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" }, - "firstname": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "lastname": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, "type": "object" @@ -28222,41 +32160,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" + "reportTemplate" ], - "example": "user", + "example": "reportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserPatchDocument": { + "JsonApiReportTemplatePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserPatch" + "$ref": "#/components/schemas/JsonApiReportTemplatePatch" } }, "required": [ @@ -28264,75 +32187,275 @@ ], "type": "object" }, - "JsonApiUserSettingIn": { - "description": "JSON:API representation of userSetting entity.", + "JsonApiReportTemplatePostOptionalId": { + "description": "JSON:API representation of reportTemplate entity.", "properties": { "attributes": { "properties": { + "areRelationsValid": { + "type": "boolean" + }, "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "title" + ], "type": "object" }, "id": { @@ -28344,22 +32467,22 @@ "type": { "description": "Object type", "enum": [ - "userSetting" + "reportTemplate" ], - "example": "userSetting", + "example": "reportTemplate", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiUserSettingInDocument": { + "JsonApiReportTemplatePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserSettingIn" + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalId" } }, "required": [ @@ -28367,8 +32490,8 @@ ], "type": "object" }, - "JsonApiUserSettingOut": { - "description": "JSON:API representation of userSetting entity.", + "JsonApiThemeIn": { + "description": "JSON:API representation of theme entity.", "properties": { "attributes": { "properties": { @@ -28377,65 +32500,15 @@ "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "name": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -28447,22 +32520,77 @@ "type": { "description": "Object type", "enum": [ - "userSetting" + "theme" ], - "example": "userSetting", + "example": "theme", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserSettingOutDocument": { + "JsonApiThemeInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserSettingOut" + "$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" @@ -28473,12 +32601,12 @@ ], "type": "object" }, - "JsonApiUserSettingOutList": { + "JsonApiThemeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" + "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" }, "type": "array", "uniqueItems": true @@ -28500,57 +32628,81 @@ ], "type": "object" }, - "JsonApiUserSettingOutWithLinks": { + "JsonApiThemeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserSettingOut" + "$ref": "#/components/schemas/JsonApiThemeOut" }, { "$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" + "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" + } }, - "type": "array" + "required": [ + "attributes", + "id", + "type" + ], + "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserLinkage" + "JsonApiThemePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemePatch" } - ] + }, + "required": [ + "data" + ], + "type": "object" }, - "JsonApiVisualizationObjectIn": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiUserDataFilterIn": { + "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "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" + "maql": { + "maxLength": 10000, + "type": "string" }, "tags": { "items": { @@ -28564,7 +32716,7 @@ } }, "required": [ - "content" + "maql" ], "type": "object" }, @@ -28574,12 +32726,39 @@ "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": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -28590,10 +32769,10 @@ ], "type": "object" }, - "JsonApiVisualizationObjectInDocument": { + "JsonApiUserDataFilterInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + "$ref": "#/components/schemas/JsonApiUserDataFilterIn" } }, "required": [ @@ -28601,85 +32780,20 @@ ], "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.", + "JsonApiUserDataFilterOut": { + "description": "JSON:API representation of userDataFilter 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" - }, - "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}", + "maql": { + "maxLength": 10000, "type": "string" }, "tags": { @@ -28694,7 +32808,7 @@ } }, "required": [ - "content" + "maql" ], "type": "object" }, @@ -28743,10 +32857,10 @@ ], "type": "object" }, - "certifiedBy": { + "computedAttributes": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" } }, "required": [ @@ -28754,10 +32868,10 @@ ], "type": "object" }, - "createdBy": { + "datasets": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ @@ -28765,10 +32879,10 @@ ], "type": "object" }, - "datasets": { + "facts": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, "required": [ @@ -28776,10 +32890,10 @@ ], "type": "object" }, - "facts": { + "labels": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ @@ -28787,10 +32901,10 @@ ], "type": "object" }, - "labels": { + "metrics": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ @@ -28798,10 +32912,10 @@ ], "type": "object" }, - "metrics": { + "parameters": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ @@ -28809,10 +32923,10 @@ ], "type": "object" }, - "modifiedBy": { + "user": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ @@ -28820,10 +32934,10 @@ ], "type": "object" }, - "parameters": { + "userGroup": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ @@ -28837,9 +32951,9 @@ "type": { "description": "Object type", "enum": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -28850,21 +32964,34 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutDocument": { + "JsonApiUserDataFilterOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$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": [ @@ -28872,12 +32999,43 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutList": { + "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/JsonApiVisualizationObjectOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true @@ -28885,7 +33043,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" }, "type": "array", "uniqueItems": true @@ -28897,6 +33055,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" @@ -28907,41 +33073,31 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutWithLinks": { + "JsonApiUserDataFilterOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiVisualizationObjectPatch": { - "description": "JSON:API representation of patching visualizationObject entity.", + "JsonApiUserDataFilterPatch": { + "description": "JSON:API representation of patching userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "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" + "maql": { + "maxLength": 10000, + "type": "string" }, "tags": { "items": { @@ -28962,12 +33118,39 @@ "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": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -28978,10 +33161,10 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPatchDocument": { + "JsonApiUserDataFilterPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" } }, "required": [ @@ -28989,31 +33172,21 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalId": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiUserDataFilterPostOptionalId": { + "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "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" + "maql": { + "maxLength": 10000, + "type": "string" }, "tags": { "items": { @@ -29027,7 +33200,7 @@ } }, "required": [ - "content" + "maql" ], "type": "object" }, @@ -29037,12 +33210,39 @@ "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": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -29052,10 +33252,10 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalIdDocument": { + "JsonApiUserDataFilterPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" } }, "required": [ @@ -29063,259 +33263,14 @@ ], "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.", + "JsonApiUserGroupIn": { + "description": "JSON:API representation of userGroup 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" - }, - "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": { + "name": { "maxLength": 255, "type": "string" - }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" } }, "type": "object" @@ -29328,87 +33283,10 @@ }, "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": { + "parents": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -29422,9 +33300,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceAutomation" + "userGroup" ], - "example": "workspaceAutomation", + "example": "userGroup", "type": "string" } }, @@ -29434,59 +33312,10 @@ ], "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", + "JsonApiUserGroupInDocument": { "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" - } - }, - "type": "object" + "$ref": "#/components/schemas/JsonApiUserGroupIn" } }, "required": [ @@ -29494,89 +33323,35 @@ ], "type": "object" }, - "JsonApiWorkspaceAutomationOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiWorkspaceColorPaletteIn": { - "description": "JSON:API representation of workspaceColorPalette entity.", + "JsonApiUserGroupLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "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" + "userGroup" ], - "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.", + "JsonApiUserGroupOut": { + "description": "JSON:API representation of userGroup 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": { @@ -29585,26 +33360,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "meta": { + "relationships": { "properties": { - "origin": { + "parents": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ - "originId", - "originType" + "data" ], "type": "object" } @@ -29614,26 +33379,46 @@ "type": { "description": "Object type", "enum": [ - "workspaceColorPalette" + "userGroup" ], - "example": "workspaceColorPalette", + "example": "userGroup", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutDocument": { + "JsonApiUserGroupOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "$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": [ @@ -29641,12 +33426,20 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutList": { + "JsonApiUserGroupOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29658,6 +33451,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" @@ -29668,26 +33469,21 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutWithLinks": { + "JsonApiUserGroupOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "$ref": "#/components/schemas/JsonApiUserGroupOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceColorPalettePatch": { - "description": "JSON:API representation of patching workspaceColorPalette entity.", + "JsonApiUserGroupPatch": { + "description": "JSON:API representation of patching userGroup entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, "name": { "maxLength": 255, "type": "string" @@ -29701,65 +33497,12 @@ "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": { + "parents": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -29773,9 +33516,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilter" + "userGroup" ], - "example": "workspaceDataFilter", + "example": "userGroup", "type": "string" } }, @@ -29785,10 +33528,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterInDocument": { + "JsonApiUserGroupPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" + "$ref": "#/components/schemas/JsonApiUserGroupPatch" } }, "required": [ @@ -29796,7 +33539,23 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterLinkage": { + "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": { @@ -29804,7 +33563,7 @@ }, "type": { "enum": [ - "workspaceDataFilter" + "userIdentifier" ], "type": "string" } @@ -29815,20 +33574,20 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOut": { - "description": "JSON:API representation of workspaceDataFilter entity.", + "JsonApiUserIdentifierOut": { + "description": "JSON:API representation of userIdentifier entity.", "properties": { "attributes": { "properties": { - "columnName": { + "email": { "maxLength": 255, "type": "string" }, - "description": { - "maxLength": 10000, + "firstname": { + "maxLength": 255, "type": "string" }, - "title": { + "lastname": { "maxLength": 255, "type": "string" } @@ -29841,54 +33600,12 @@ "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" + "userIdentifier" ], - "example": "workspaceDataFilter", + "example": "userIdentifier", "type": "string" } }, @@ -29898,18 +33615,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutDocument": { + "JsonApiUserIdentifierOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -29920,20 +33629,12 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutList": { + "JsonApiUserIdentifierOutList": { "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" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -29955,102 +33656,50 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutWithLinks": { + "JsonApiUserIdentifierOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceDataFilterPatch": { - "description": "JSON:API representation of patching workspaceDataFilter entity.", + "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": { - "columnName": { + "authenticationId": { "maxLength": 255, "type": "string" }, - "description": { - "maxLength": 10000, + "email": { + "maxLength": 255, "type": "string" }, - "title": { + "firstname": { "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": { + "lastname": { "maxLength": 255, "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" } }, "type": "object" @@ -30063,10 +33712,10 @@ }, "relationships": { "properties": { - "workspaceDataFilter": { + "userGroups": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -30080,9 +33729,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilterSetting" + "user" ], - "example": "workspaceDataFilterSetting", + "example": "user", "type": "string" } }, @@ -30092,10 +33741,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingInDocument": { + "JsonApiUserInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" + "$ref": "#/components/schemas/JsonApiUserIn" } }, "required": [ @@ -30103,7 +33752,7 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingLinkage": { + "JsonApiUserLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { @@ -30111,7 +33760,7 @@ }, "type": { "enum": [ - "workspaceDataFilterSetting" + "user" ], "type": "string" } @@ -30122,24 +33771,31 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOut": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "JsonApiUserOut": { + "description": "JSON:API representation of user entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, + "authenticationId": { + "maxLength": 255, "type": "string" }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" + "email": { + "maxLength": 255, + "type": "string" }, - "title": { + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { "maxLength": 255, "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" } }, "type": "object" @@ -30150,38 +33806,12 @@ "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": { + "userGroups": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -30195,9 +33825,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilterSetting" + "user" ], - "example": "workspaceDataFilterSetting", + "example": "user", "type": "string" } }, @@ -30207,21 +33837,34 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutDocument": { + "JsonApiUserOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "$ref": "#/components/schemas/JsonApiUserOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "$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": [ @@ -30229,12 +33872,12 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutList": { + "JsonApiUserOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30242,7 +33885,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30254,6 +33897,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" @@ -30264,34 +33915,41 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutWithLinks": { + "JsonApiUserOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "$ref": "#/components/schemas/JsonApiUserOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceDataFilterSettingPatch": { - "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", + "JsonApiUserPatch": { + "description": "JSON:API representation of patching user entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, + "authenticationId": { + "maxLength": 255, "type": "string" }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" + "email": { + "maxLength": 255, + "type": "string" }, - "title": { + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { "maxLength": 255, "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" } }, "type": "object" @@ -30304,10 +33962,10 @@ }, "relationships": { "properties": { - "workspaceDataFilter": { + "userGroups": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -30321,9 +33979,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilterSetting" + "user" ], - "example": "workspaceDataFilterSetting", + "example": "user", "type": "string" } }, @@ -30333,10 +33991,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingPatchDocument": { + "JsonApiUserPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" + "$ref": "#/components/schemas/JsonApiUserPatch" } }, "required": [ @@ -30344,110 +34002,81 @@ ], "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.", + "JsonApiUserSettingIn": { + "description": "JSON:API representation of userSetting 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" - ], + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, "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": { + "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": { @@ -30459,23 +34088,22 @@ "type": { "description": "Object type", "enum": [ - "workspaceExportTemplate" + "userSetting" ], - "example": "workspaceExportTemplate", + "example": "userSetting", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateInDocument": { + "JsonApiUserSettingInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" + "$ref": "#/components/schemas/JsonApiUserSettingIn" } }, "required": [ @@ -30483,87 +34111,81 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOut": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "JsonApiUserSettingOut": { + "description": "JSON:API representation of userSetting 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" - ], + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, "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": { + "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": "object" + "type": "string" } }, - "required": [ - "name" - ], "type": "object" }, "id": { @@ -30572,52 +34194,25 @@ "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" + "userSetting" ], - "example": "workspaceExportTemplate", + "example": "userSetting", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutDocument": { + "JsonApiUserSettingOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + "$ref": "#/components/schemas/JsonApiUserSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -30628,12 +34223,12 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutList": { + "JsonApiUserSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" }, "type": "array", "uniqueItems": true @@ -30655,94 +34250,94 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutWithLinks": { + "JsonApiUserSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + "$ref": "#/components/schemas/JsonApiUserSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceExportTemplatePatch": { - "description": "JSON:API representation of patching workspaceExportTemplate entity.", + "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": { - "dashboardSlidesTemplate": { - "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", "nullable": true, "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], + "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": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" + "$ref": "#/components/schemas/ConditionalFormattingRule" }, - "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" + "enabled", + "rules" ], "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" + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } + "someBoolProp": false }, - "required": [ - "appliedOn" - ], "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": { @@ -30754,9 +34349,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceExportTemplate" + "visualizationObject" ], - "example": "workspaceExportTemplate", + "example": "visualizationObject", "type": "string" } }, @@ -30767,10 +34362,10 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePatchDocument": { + "JsonApiVisualizationObjectInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" + "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" } }, "required": [ @@ -30778,187 +34373,123 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalId": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "JsonApiVisualizationObjectLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "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" + "visualizationObject" ], - "example": "workspaceExportTemplate", "type": "string" } }, "required": [ - "attributes", + "id", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiWorkspaceIn": { - "description": "JSON:API representation of workspace entity.", + "JsonApiVisualizationObjectOut": { + "description": "JSON:API representation of visualizationObject entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" + "areRelationsValid": { + "type": "boolean" }, - "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.", + "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": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" + "$ref": "#/components/schemas/ConditionalFormattingRule" }, "type": "array" } }, "required": [ - "id" + "enabled", + "rules" ], "type": "object" }, - "description": { - "maxLength": 255, - "nullable": true, + "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" }, - "earlyAccess": { - "deprecated": true, - "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", - "maxLength": 255, + "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" }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", + "tags": { "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", + "title": { "maxLength": 255, - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, + "required": [ + "content" + ], "type": "object" }, "id": { @@ -30967,225 +34498,149 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "parent": { + "origin": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" } }, "required": [ - "data" + "originId", + "originType" ], "type": "object" + }, + "permissions": { + "description": "List of valid permissions for a logged-in user.", + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" } }, "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": { + "relationships": { "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.", + "attributes": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ - "id" + "data" ], "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" + "certifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", - "items": { - "maxLength": 255, - "type": "string" + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } }, - "nullable": true, - "type": "array" + "required": [ + "data" + ], + "type": "object" }, - "managed": { - "description": "Whether the object is platform-managed and read-only.", - "type": "boolean" + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" + "datasets": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" }, - "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": { + "facts": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, + "required": [ + "data" + ], "type": "object" }, - "dataModel": { + "labels": { "properties": { - "datasetCount": { - "description": "include the number of dataset of each workspace", - "format": "int32", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ - "datasetCount" + "data" ], "type": "object" }, - "hierarchy": { + "metrics": { "properties": { - "childrenCount": { - "description": "include the number of direct children of each workspace", - "format": "int32", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ - "childrenCount" + "data" ], "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { + "required": [ + "data" + ], + "type": "object" + }, + "parameters": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ @@ -31199,33 +34654,47 @@ "type": { "description": "Object type", "enum": [ - "workspace" + "visualizationObject" ], - "example": "workspace", + "example": "visualizationObject", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceOutDocument": { + "JsonApiVisualizationObjectOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$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": [ @@ -31233,12 +34702,12 @@ ], "type": "object" }, - "JsonApiWorkspaceOutList": { + "JsonApiVisualizationObjectOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" }, "type": "array", "uniqueItems": true @@ -31246,7 +34715,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" }, "type": "array", "uniqueItems": true @@ -31258,6 +34727,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" @@ -31268,79 +34745,72 @@ ], "type": "object" }, - "JsonApiWorkspaceOutWithLinks": { + "JsonApiVisualizationObjectOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspacePatch": { - "description": "JSON:API representation of patching workspace entity.", + "JsonApiVisualizationObjectPatch": { + "description": "JSON:API representation of patching visualizationObject entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" + "areRelationsValid": { + "type": "boolean" }, - "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.", + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" + "$ref": "#/components/schemas/ConditionalFormattingRule" }, "type": "array" } }, "required": [ - "id" + "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": 255, - "nullable": true, + "maxLength": 10000, "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" + "isHidden": { + "type": "boolean" }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", + "tags": { "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", + "title": { "maxLength": 255, - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, @@ -31352,41 +34822,122 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "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": { - "parent": { + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "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": [ - "data" + "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": [ - "workspace" + "visualizationObject" ], - "example": "workspace", + "example": "visualizationObject", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiWorkspacePatchDocument": { + "JsonApiVisualizationObjectPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspacePatch" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" } }, "required": [ @@ -31394,176 +34945,262 @@ ], "type": "object" }, - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], - "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" - } + "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" }, - "required": [ - "id", - "type" - ], - "type": "object" + "type": "array" }, - "JsonApiWorkspaceSettingInDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" + "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" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "JsonApiWorkspaceSettingOut": { - "description": "JSON:API representation of workspaceSetting entity.", + "JsonApiWorkspaceAutomationOut": { + "description": "JSON:API representation of workspaceAutomation entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "type": { + "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": [ - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "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" @@ -31574,26 +35211,93 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "meta": { + "relationships": { "properties": { - "origin": { + "analyticalDashboard": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ - "originId", - "originType" + "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" } @@ -31603,9 +35307,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceSetting" + "workspaceAutomation" ], - "example": "workspaceSetting", + "example": "workspaceAutomation", "type": "string" } }, @@ -31615,27 +35319,46 @@ ], "type": "object" }, - "JsonApiWorkspaceSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + "JsonApiWorkspaceAutomationOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, - "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" - }, + { + "$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 }, @@ -31646,6 +35369,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" @@ -31656,18 +35387,18 @@ ], "type": "object" }, - "JsonApiWorkspaceSettingOutWithLinks": { + "JsonApiWorkspaceAutomationOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceSettingPatch": { - "description": "JSON:API representation of patching workspaceSetting entity.", + "JsonApiWorkspaceColorPaletteIn": { + "description": "JSON:API representation of workspaceColorPalette entity.", "properties": { "attributes": { "properties": { @@ -31676,65 +35407,15 @@ "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "name": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -31746,22 +35427,23 @@ "type": { "description": "Object type", "enum": [ - "workspaceSetting" + "workspaceColorPalette" ], - "example": "workspaceSetting", + "example": "workspaceColorPalette", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceSettingPatchDocument": { + "JsonApiWorkspaceColorPaletteInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteIn" } }, "required": [ @@ -31769,8 +35451,8 @@ ], "type": "object" }, - "JsonApiWorkspaceSettingPostOptionalId": { - "description": "JSON:API representation of workspaceSetting entity.", + "JsonApiWorkspaceColorPaletteOut": { + "description": "JSON:API representation of workspaceColorPalette entity.", "properties": { "attributes": { "properties": { @@ -31779,65 +35461,15 @@ "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "name": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -31846,24 +35478,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": [ - "workspaceSetting" + "workspaceColorPalette" ], - "example": "workspaceSetting", + "example": "workspaceColorPalette", "type": "string" } }, "required": [ + "attributes", + "id", "type" ], "type": "object" }, - "JsonApiWorkspaceSettingPostOptionalIdDocument": { + "JsonApiWorkspaceColorPaletteOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ @@ -31871,8 +35534,45 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeIn": { - "description": "JSON:API representation of workspaceTheme entity.", + "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": { @@ -31886,10 +35586,6 @@ "type": "string" } }, - "required": [ - "content", - "name" - ], "type": "object" }, "id": { @@ -31901,9 +35597,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceTheme" + "workspaceColorPalette" ], - "example": "workspaceTheme", + "example": "workspaceColorPalette", "type": "string" } }, @@ -31914,10 +35610,10 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeInDocument": { + "JsonApiWorkspaceColorPalettePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatch" } }, "required": [ @@ -31925,25 +35621,111 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOut": { - "description": "JSON:API representation of workspaceTheme entity.", + "JsonApiWorkspaceDataFilterIn": { + "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "columnName": { + "maxLength": 255, + "type": "string" }, - "name": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { "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" + }, + "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": { @@ -31978,29 +35760,65 @@ }, "type": "object" }, + "relationships": { + "properties": { + "filterSettings": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" + }, "type": { "description": "Object type", "enum": [ - "workspaceTheme" + "workspaceDataFilter" ], - "example": "workspaceTheme", + "example": "workspaceDataFilter", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceThemeOutDocument": { + "JsonApiWorkspaceDataFilterOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "$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": [ @@ -32008,12 +35826,20 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOutList": { + "JsonApiWorkspaceDataFilterOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, "type": "array", "uniqueItems": true @@ -32025,6 +35851,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" @@ -32035,27 +35869,30 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOutWithLinks": { + "JsonApiWorkspaceDataFilterOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceThemePatch": { - "description": "JSON:API representation of patching workspaceTheme entity.", + "JsonApiWorkspaceDataFilterPatch": { + "description": "JSON:API representation of patching workspaceDataFilter entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "columnName": { + "maxLength": 255, + "type": "string" }, - "name": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { "maxLength": 255, "type": "string" } @@ -32068,26 +35905,41 @@ "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": [ - "workspaceTheme" + "workspaceDataFilter" ], - "example": "workspaceTheme", + "example": "workspaceDataFilter", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceThemePatchDocument": { + "JsonApiWorkspaceDataFilterPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" } }, "required": [ @@ -32095,177 +35947,69 @@ ], "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" - }, - "KeyConfig": { - "description": "Key configuration for the table data model.", - "discriminator": { - "mapping": { - "aggregate": "#/components/schemas/AggregateKeyConfig", - "duplicate": "#/components/schemas/DuplicateKeyConfig", - "primary": "#/components/schemas/PrimaryKeyConfig", - "unique": "#/components/schemas/UniqueKeyConfig" - }, - "propertyName": "type" - }, + "JsonApiWorkspaceDataFilterSettingIn": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", "properties": { - "type": { - "type": "string" - } - }, - "required": [ - "type" - ], - "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" + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" }, - "labelName": { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "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" + "relationships": { + "properties": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": "array" - }, - "metric": { - "$ref": "#/components/schemas/MeasureItem" + "type": "object" }, - "sortDirection": { - "default": "DESC", - "description": "Sorting elements - ascending/descending order.", + "type": { + "description": "Object type", "enum": [ - "ASC", - "DESC" + "workspaceDataFilterSetting" ], + "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ - "metric" - ], - "type": "object" - }, - "KeyDriversResponse": { - "properties": { - "dimensions": { - "items": { - "$ref": "#/components/schemas/KeyDriversDimension" - }, - "type": "array" - }, - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "dimensions", - "links" + "id", + "type" ], "type": "object" }, - "KeyDriversResult": { + "JsonApiWorkspaceDataFilterSettingInDocument": { "properties": { "data": { - "type": "object" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" } }, "required": [ @@ -32273,21 +36017,16 @@ ], "type": "object" }, - "LabelIdentifier": { - "description": "A label identifier.", + "JsonApiWorkspaceDataFilterSettingLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { - "description": "Label ID.", - "example": "label_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { - "description": "A type of the label.", "enum": [ - "label" + "workspaceDataFilterSetting" ], - "example": "label", "type": "string" } }, @@ -32297,1093 +36036,1694 @@ ], "type": "object" }, - "LabelPermissions": { + "JsonApiWorkspaceDataFilterSettingOut": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "type": "string" + }, + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + } }, - "type": "array" + "type": "object" }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" + "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": "array" + "type": "object" }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" + "relationships": { + "properties": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": "array" + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilterSetting" + ], + "example": "workspaceDataFilterSetting", + "type": "string" } }, "required": [ - "rules", - "userGroups", - "users" + "id", + "type" ], "type": "object" }, - "LabelPermissionsAssignment": { - "description": "Desired levels of permissions on a label for an assignee.", + "JsonApiWorkspaceDataFilterSettingOutDocument": { "properties": { - "permissions": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, + "included": { + "description": "Included resources", "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, - "type": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "LabelPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" + "type": "array", + "uniqueItems": true }, - { + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "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" } - ], - "description": "Desired levels of label permissions for an assignee identified by an identifier.", + }, "required": [ - "assigneeIdentifier", - "permissions" + "data" ], "type": "object" }, - "LabelPermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" + "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": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" + "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" } - ], - "description": "Desired levels of label permissions for a collection of assignees identified by a rule.", + }, "required": [ - "assigneeRule", - "permissions" + "data" ], "type": "object" }, - "ListLinks": { + "JsonApiWorkspaceDataFilterSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/ObjectLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" }, { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceDataFilterSettingPatch": { + "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", + "properties": { + "attributes": { "properties": { - "next": { - "description": "A string containing the link's URL for the next page of data.", - "format": "uri", + "description": { + "maxLength": 10000, + "type": "string" + }, + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, "type": "string" } }, "type": "object" - } - ] - }, - "ListLlmProviderModelsRequest": { - "properties": { - "providerConfig": { - "$ref": "#/components/schemas/LlmProviderConfig" - } - }, - "required": [ - "providerConfig" - ], - "type": "object" - }, - "ListLlmProviderModelsResponse": { - "properties": { - "message": { - "description": "Message about the listing result.", + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "models": { - "description": "Available models on the provider.", - "items": { - "$ref": "#/components/schemas/LlmModel" + "relationships": { + "properties": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": "array" + "type": "object" }, - "success": { - "description": "Whether the model listing succeeded.", - "type": "boolean" + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilterSetting" + ], + "example": "workspaceDataFilterSetting", + "type": "string" } }, "required": [ - "message", - "models", - "success" + "id", + "type" ], "type": "object" }, - "LiveFeatureFlagConfiguration": { + "JsonApiWorkspaceDataFilterSettingPatchDocument": { "properties": { - "host": { - "type": "string" - }, - "key": { - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" } }, "required": [ - "host", - "key" + "data" ], "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" + "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" }, - "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" - } + "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" }, - "required": [ - "family", - "id" - ], - "type": "object" + "type": "array" }, - "LlmProviderConfig": { - "description": "Provider configuration overrides.", + "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/AnthropicProviderConfig" - }, - { - "$ref": "#/components/schemas/AwsBedrockProviderConfig" - }, - { - "$ref": "#/components/schemas/AzureFoundryProviderConfig" - }, - { - "$ref": "#/components/schemas/OpenAIProviderConfig" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" } ] }, - "LocalIdentifier": { + "JsonApiWorkspaceExportTemplateIn": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { - "format": { - "default": "#,##0.00", - "description": "Metric format.", - "example": "#,##0", - "maxLength": 2048, - "nullable": true, - "type": "string" + "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" }, - "localIdentifier": { - "description": "Local identifier of the metric to be compared.", - "example": "m1", + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "title": { - "description": "Metric title.", - "example": "Revenue", - "maxLength": 255, - "nullable": true, + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ - "localIdentifier" + "attributes", + "id", + "type" ], "type": "object" }, - "LocaleRequest": { + "JsonApiWorkspaceExportTemplateInDocument": { "properties": { - "locale": { - "description": "Requested locale in the form of language tag (see RFC 5646).", - "example": "en-US", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" } }, "required": [ - "locale" + "data" ], "type": "object" }, - "MatchAttributeFilter": { - "description": "Filter via label with given match type and literal value.", + "JsonApiWorkspaceExportTemplateOut": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { - "matchAttributeFilter": { + "attributes": { "properties": { - "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" + "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" }, - "localIdentifier": { + "name": { + "description": "User-facing name of the Slides template.", + "maxLength": 255, "type": "string" }, - "matchType": { - "description": "Requested match type.", - "enum": [ - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" + "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" - }, - "negate": { - "default": false, - "description": "Indicates whether the filter should negate the match.", - "type": "boolean" + "type": "object" } }, "required": [ - "label", - "literal", - "matchType" + "name" ], "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.", + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "siteId": { - "description": "Site ID on telemetry server.", - "format": "int32", - "type": "integer" + "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": [ - "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" - } + "attributes", + "id", + "type" ], "type": "object" }, - "MeasureExecutionResultHeader": { + "JsonApiWorkspaceExportTemplateOutDocument": { "properties": { - "measureHeader": { - "$ref": "#/components/schemas/MeasureResultHeader" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ - "measureHeader" + "data" ], "type": "object" }, - "MeasureGroupHeaders": { - "description": "Measure group headers", + "JsonApiWorkspaceExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "measureGroupHeaders": { + "data": { "items": { - "$ref": "#/components/schemas/MeasureHeader" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" }, - "type": "array" - } - }, - "type": "object" - }, - "MeasureHeader": { - "properties": { - "format": { - "description": "Format to be used to format the measure data.", - "type": "string" + "type": "array", + "uniqueItems": true }, - "localIdentifier": { - "description": "Local identifier of the measure this header relates to.", - "type": "string" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "name": { - "description": "Name of the measure.", - "type": "string" + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, "required": [ - "localIdentifier" + "data" ], "type": "object" }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", + "JsonApiWorkspaceExportTemplateOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceExportTemplatePatch": { + "description": "JSON:API representation of patching workspaceExportTemplate entity.", "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" + "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" }, - "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_-]+$", + "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": [ - "definition", - "localIdentifier" + "attributes", + "id", + "type" ], "type": "object" }, - "MeasureResultHeader": { - "description": "Header containing the information related to metrics.", + "JsonApiWorkspaceExportTemplatePatchDocument": { "properties": { - "measureIndex": { - "description": "Metric index. Starts at 0.", - "example": 0, - "format": "int32", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" } }, "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/RangeCondition" - } + "data" ], "type": "object" }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" - }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - } - ], - "type": "object" - }, - "MemoryItemCreatedByUsers": { + "JsonApiWorkspaceExportTemplatePostOptionalId": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { - "reasoning": { - "description": "Reasoning for error states", + "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" }, - "users": { - "description": "Users who created memory item", - "items": { - "$ref": "#/components/schemas/MemoryItemUser" - }, - "type": "array" + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", + "type": "string" } }, "required": [ - "reasoning", - "users" + "attributes", + "type" ], "type": "object" }, - "MemoryItemUser": { - "description": "Users who created memory item", + "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { "properties": { - "firstname": { - "description": "First name of the user who created memory item", - "type": "string" - }, - "lastname": { - "description": "Last name of the user who created memory item", - "type": "string" - }, - "userId": { - "description": "User ID of the user who created memory item", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" } }, "required": [ - "firstname", - "lastname", - "userId" + "data" ], "type": "object" }, - "Metric": { - "description": "List of metrics to be used in the new visualization", + "JsonApiWorkspaceIn": { + "description": "JSON:API representation of workspace entity.", "properties": { - "aggFunction": { - "description": "Agg function. Empty if a stored metric is used.", - "enum": [ - "COUNT", - "SUM", - "MIN", - "MAX", - "AVG", - "MEDIAN" - ], - "type": "string" + "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": "ID of the object", - "example": "revenue", + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "title": { - "description": "Title of metric.", - "type": "string" + "relationships": { + "properties": { + "parent": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" }, "type": { "description": "Object type", "enum": [ - "metric", - "fact", - "attribute" + "workspace" ], - "example": "metric", + "example": "workspace", "type": "string" } }, "required": [ "id", - "title", "type" ], "type": "object" }, - "MetricDefinitionOverride": { - "description": "(EXPERIMENTAL) Override for a catalog metric definition.", + "JsonApiWorkspaceInDocument": { "properties": { - "definition": { - "$ref": "#/components/schemas/InlineMeasureDefinition" - }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceIn" } }, "required": [ - "definition", - "item" + "data" ], "type": "object" }, - "MetricPermissions": { + "JsonApiWorkspaceLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" - }, - "type": "array" - }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" - }, - "type": "array" + "id": { + "type": "string" }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" - }, - "type": "array" + "type": { + "enum": [ + "workspace" + ], + "type": "string" } }, "required": [ - "rules", - "userGroups", - "users" + "id", + "type" ], "type": "object" }, - "MetricPermissionsAssignment": { - "description": "Desired levels of permissions on a metric for an assignee.", + "JsonApiWorkspaceOut": { + "description": "JSON:API representation of workspace entity.", "properties": { - "permissions": { - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" + "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": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "MetricPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsAssignment" + "type": "object" }, - { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "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" } - ], - "description": "Desired levels of metric permissions for an assignee identified by an identifier.", + }, "required": [ - "assigneeIdentifier", - "permissions" + "id", + "type" ], "type": "object" }, - "MetricPermissionsForAssigneeRule": { - "allOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsAssignment" + "JsonApiWorkspaceOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, - { + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + }, + "meta": { "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" + "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" } - ], - "description": "Desired levels of metric permissions for a collection of assignees identified by a rule.", + }, "required": [ - "assigneeRule", - "permissions" + "data" ], "type": "object" }, - "MetricRecord": { + "JsonApiWorkspaceOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "formattedValue": { - "type": "string" - }, - "value": { - "format": "double", - "type": "number" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "MetricValueChange": { - "description": "Individual change analysis data item", - "properties": { - "attributeName": { - "description": "The name of the attribute being analyzed", - "type": "string" - }, - "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" + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, - "metricValueInReferencePeriod": { - "description": "The metric value in the reference period", - "format": "double", - "type": "number" + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, - "overallMetricValueInAnalyzedPeriod": { - "description": "The overall metric value in the analyzed period", - "format": "double", - "type": "number" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "overallMetricValueInReferencePeriod": { - "description": "The overall metric value in the reference period", - "format": "double", - "type": "number" + "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": [ - "attributeName", - "attributeValue", - "attributeValuesChangeMean", - "attributeValuesChangeStd", - "isSignificantChange", - "metricValueDelta", - "metricValueDeltaAbs", - "metricValueInAnalyzedPeriod", - "metricValueInReferencePeriod", - "overallMetricValueInAnalyzedPeriod", - "overallMetricValueInReferencePeriod" + "data" ], "type": "object" }, - "ModelTestResult": { - "description": "Per-model test results.", - "properties": { - "message": { - "description": "Message about the model test result.", - "type": "string" - }, - "modelId": { - "description": "The model ID that was tested.", - "type": "string" + "JsonApiWorkspaceOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, - "successful": { - "description": "Whether the model test was successful.", - "type": "boolean" + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - }, - "required": [ - "message", - "modelId", - "successful" - ], - "type": "object" + ] }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", + "JsonApiWorkspacePatch": { + "description": "JSON:API representation of patching workspace entity.", "properties": { - "negativeAttributeFilter": { + "attributes": { "properties": { - "applyOnResult": { - "type": "boolean" + "cacheExtraLimit": { + "format": "int64", + "type": "integer" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "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" }, - "localIdentifier": { + "description": { + "maxLength": 255, + "nullable": true, "type": "string" }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" + "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" }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + "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" } }, - "required": [ - "label", - "notIn" - ], "type": "object" - } - }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" - }, - "Note": { - "properties": { - "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": [ - "note" - ], - "type": "object", - "xml": { - "name": "notes", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } - }, - "Notification": { - "properties": { - "automationId": { - "type": "string" - }, - "createdAt": { - "format": "date-time", + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/AutomationNotification" - }, - { - "$ref": "#/components/schemas/TestNotification" + "relationships": { + "properties": { + "parent": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } - ] - }, - "id": { - "type": "string" - }, - "isRead": { - "type": "boolean" - }, - "workspaceId": { - "type": "string" - } - }, - "required": [ - "createdAt", - "data", - "id", - "isRead" - ], - "type": "object" - }, - "NotificationChannelDestination": { - "oneOf": [ - { - "$ref": "#/components/schemas/Webhook" - }, - { - "$ref": "#/components/schemas/Smtp" - }, - { - "$ref": "#/components/schemas/DefaultSmtp" - }, - { - "$ref": "#/components/schemas/InPlatform" - } - ], - "type": "object" - }, - "NotificationContent": { - "discriminator": { - "mapping": { - "AUTOMATION": "#/components/schemas/AutomationNotification", - "TEST": "#/components/schemas/TestNotification" + }, + "type": "object" }, - "propertyName": "type" - }, - "properties": { "type": { + "description": "Object type", + "enum": [ + "workspace" + ], + "example": "workspace", "type": "string" } }, "required": [ + "id", "type" ], "type": "object" }, - "NotificationFilter": { + "JsonApiWorkspacePatchDocument": { "properties": { - "filter": { - "type": "string" - }, - "title": { - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspacePatch" } }, "required": [ - "filter", - "title" + "data" ], "type": "object" }, - "NotificationParameter": { + "JsonApiWorkspaceSettingIn": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { - "id": { - "type": "string" + "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" }, - "title": { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "value": { + "type": { + "description": "Object type", + "enum": [ + "workspaceSetting" + ], + "example": "workspaceSetting", "type": "string" } }, "required": [ "id", - "value" + "type" ], "type": "object" }, - "Notifications": { + "JsonApiWorkspaceSettingInDocument": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/Notification" - }, - "type": "array" - }, - "meta": { - "$ref": "#/components/schemas/NotificationsMeta" - } - }, - "required": [ - "data", - "meta" - ], - "type": "object" - }, - "NotificationsMeta": { - "properties": { - "total": { - "$ref": "#/components/schemas/NotificationsMetaTotal" - } - }, - "type": "object" - }, - "NotificationsMetaTotal": { - "properties": { - "all": { - "format": "int64", - "type": "integer" - }, - "unread": { - "format": "int64", - "type": "integer" + "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" } }, "required": [ - "all", - "unread" + "data" ], "type": "object" }, - "NumberConstraints": { - "properties": { - "max": { - "format": "double", - "type": "number" - }, - "min": { - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "NumberParameterDefinition": { + "JsonApiWorkspaceSettingOut": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { - "constraints": { - "$ref": "#/components/schemas/NumberConstraints" - }, - "defaultValue": { - "format": "double", - "type": "number" - }, - "type": { - "description": "The parameter type.", - "enum": [ - "NUMBER" + "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": [ - "defaultValue", + "id", "type" ], "type": "object" }, - "ObjectLinks": { + "JsonApiWorkspaceSettingOutDocument": { "properties": { - "self": { - "description": "A string containing the link's URL.", - "format": "uri", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ - "self" + "data" ], "type": "object" }, - "ObjectLinksContainer": { + "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/ObjectLinks" + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "ObjectReference": { + "JsonApiWorkspaceSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "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": "Object identifier (e.g. widget ID, metric ID).", + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { - "description": "Type of the referenced object.", + "description": "Object type", "enum": [ - "WIDGET", - "METRIC", - "ATTRIBUTE", - "DASHBOARD" + "workspaceSetting" ], + "example": "workspaceSetting", "type": "string" } }, @@ -33393,2886 +37733,2693 @@ ], "type": "object" }, - "ObjectReferenceGroup": { + "JsonApiWorkspaceSettingPatchDocument": { "properties": { - "context": { - "$ref": "#/components/schemas/ObjectReference" - }, - "objects": { - "description": "Objects the user explicitly referenced within this context.", - "items": { - "$ref": "#/components/schemas/ObjectReference" - }, - "type": "array" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" } }, "required": [ - "objects" + "data" ], "type": "object" }, - "ObjectStorageInfo": { - "description": "Descriptor of a registered ObjectStorage. Provider credentials are stripped — only fields useful for identifying the storage are returned.", + "JsonApiWorkspaceSettingPostOptionalId": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { - "name": { - "description": "Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds.", - "example": "s3-data-lake", - "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" + "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" + } }, - "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", "type": "object" }, - "storageId": { - "description": "Stable identifier of the storage configuration (UUID).", + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "storageType": { - "description": "Provider type.", - "example": "s3", + "type": { + "description": "Object type", + "enum": [ + "workspaceSetting" + ], + "example": "workspaceSetting", "type": "string" } }, "required": [ - "name", - "storageConfig", - "storageId", - "storageType" + "type" ], "type": "object" }, - "OpenAIProviderConfig": { - "description": "Configuration for OpenAI provider.", + "JsonApiWorkspaceSettingPostOptionalIdDocument": { "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.", - "enum": [ - "OPENAI" - ], - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" } }, "required": [ - "auth", - "type" + "data" ], "type": "object" }, - "OpenAiApiKeyAuth": { - "allOf": [ - { + "JsonApiWorkspaceThemeIn": { + "description": "JSON:API representation of workspaceTheme entity.", + "properties": { + "attributes": { "properties": { - "apiKey": { - "description": "OpenAI API key.", - "maxLength": 255, - "nullable": true, - "type": "string", - "writeOnly": true + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "type": { - "description": "Authentication type.", - "enum": [ - "API_KEY" - ], + "name": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "name" + ], "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" } - ], + }, "required": [ + "attributes", + "id", "type" ], "type": "object" }, - "OpenAiProviderAuth": { - "description": "Authentication configuration.", - "oneOf": [ - { - "$ref": "#/components/schemas/OpenAiApiKeyAuth" - } - ], - "type": "object" - }, - "OpenTelemetryService": { - "description": "OpenTelemetry service.", + "JsonApiWorkspaceThemeInDocument": { "properties": { - "host": { - "description": "Telemetry host to send events to.", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" } }, "required": [ - "host" + "data" ], "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" - }, + "JsonApiWorkspaceThemeOut": { + "description": "JSON:API representation of workspaceTheme entity.", "properties": { + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "name" + ], + "type": "object" + }, "id": { - "description": "Id of the operation", + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "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* `create-pipe-table` — Creating a pipe table backed by an S3 data source.\n* `delete-pipe-table` — Deleting a pipe table.\n* `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.\n* `refresh-partition` — Refreshing a specific Hive partition (delete + re-load from S3).\n", + "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": [ - "provision-database", - "deprovision-database", - "run-service-command", - "create-pipe-table", - "delete-pipe-table", - "analyze-statistics", - "refresh-partition" + "workspaceTheme" ], - "type": "string" - }, - "status": { + "example": "workspaceTheme", "type": "string" } }, "required": [ + "attributes", "id", - "kind", - "status" + "type" ], "type": "object" }, - "OperationError": { - "description": "Error information for a failed operation", + "JsonApiWorkspaceThemeOutDocument": { "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": { - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" }, - "workspaceId": { - "type": "string" + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ - "id", - "workspaceId" + "data" ], "type": "object" }, - "OrganizationAutomationManagementBulkRequest": { + "JsonApiWorkspaceThemeOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "automations": { + "data": { "items": { - "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" }, - "type": "array" + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, "required": [ - "automations" + "data" ], "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" + "JsonApiWorkspaceThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - }, - "required": [ - "extraCacheBudget" - ], - "type": "object" + ] }, - "OrganizationCacheUsage": { - "description": "Data about the whole organization's cache usage.", + "JsonApiWorkspaceThemePatch": { + "description": "JSON:API representation of patching workspaceTheme entity.", "properties": { - "current": { - "$ref": "#/components/schemas/OrganizationCurrentCacheUsage" - }, - "removalIntervals": { - "description": "List of cache removal intervals.", - "items": { - "$ref": "#/components/schemas/CacheRemovalInterval" + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } }, - "type": "array" + "type": "object" }, - "settings": { - "$ref": "#/components/schemas/OrganizationCacheSettings" + "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": [ - "current", - "removalIntervals", - "settings" + "attributes", + "id", + "type" ], "type": "object" }, - "OrganizationCurrentCacheUsage": { - "description": "Current cache usage of the organization.", + "JsonApiWorkspaceThemePatchDocument": { "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", - "type": "string" - }, - "removedSinceStart": { - "description": "Bytes removed since start due to insufficient cache.", - "format": "int64", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" } }, "required": [ - "cacheUsed", - "removedSinceStart" + "data" ], "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" + "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" } - }, - "required": [ - "assigneeIdentifier", - "permissions" - ], + ] + }, + "JsonNode": { + "description": "Free-form JSON object", + "example": {}, + "maxLength": 15000, + "nullable": true, "type": "object" }, - "OutlierDetectionRequest": { + "KeyDriversDimension": { "properties": { - "attributes": { - "description": "Attributes to be used in the computation.", - "items": { - "$ref": "#/components/schemas/AttributeItem" - }, - "type": "array" + "attribute": { + "$ref": "#/components/schemas/RestApiIdentifier" }, - "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" + "attributeName": { + "type": "string" }, - "filters": { - "description": "Various filter types to filter the execution result.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" - }, - "type": "array" + "format": { + "$ref": "#/components/schemas/AttributeFormat" }, "granularity": { - "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", "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", - "YEAR" + "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" }, - "measures": { - "items": { - "$ref": "#/components/schemas/MeasureItem" - }, - "minItems": 1, - "type": "array" + "label": { + "$ref": "#/components/schemas/RestApiIdentifier" }, - "sensitivity": { - "description": "Sensitivity level for outlier detection", + "labelName": { + "type": "string" + }, + "valueType": { "enum": [ - "LOW", - "MEDIUM", - "HIGH" + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" ], "type": "string" } }, "required": [ - "attributes", - "granularity", - "measures", - "sensitivity" + "attribute", + "attributeName", + "label", + "labelName" ], "type": "object" }, - "OutlierDetectionResponse": { + "KeyDriversRequest": { "properties": { - "links": { - "$ref": "#/components/schemas/ExecutionLinks" + "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" + }, + "sortDirection": { + "default": "DESC", + "description": "Sorting elements - ascending/descending order.", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" } }, "required": [ - "links" + "metric" ], "type": "object" }, - "OutlierDetectionResult": { + "KeyDriversResponse": { "properties": { - "attribute": { - "description": "Attribute values for outlier detection results.", + "dimensions": { "items": { - "type": "string" + "$ref": "#/components/schemas/KeyDriversDimension" }, - "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, - "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" + "links": { + "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ - "attribute", - "values" + "dimensions", + "links" ], "type": "object" }, - "Over": { + "KeyDriversResult": { "properties": { - "attributes": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "type": "array" + "data": { + "type": "object" } }, "required": [ - "attributes" + "data" ], "type": "object" }, - "PageMetadata": { + "LabelIdentifier": { + "description": "A label identifier.", "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": { + "description": "Label ID.", + "example": "label_id", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" }, - "totalPages": { - "description": "The total number of pages", - "format": "int32", - "type": "integer" + "type": { + "description": "A type of the label.", + "enum": [ + "label" + ], + "example": "label", + "type": "string" } }, + "required": [ + "id", + "type" + ], "type": "object" }, - "Paging": { - "description": "Current page description.", + "LabelPermissions": { "properties": { - "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" + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" }, - "offset": { - "description": "Offset of this page.", - "example": 10, - "format": "int32", - "type": "integer" + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" }, - "total": { - "description": "Count of returnable items ignoring paging.", - "example": 100, - "format": "int32", - "type": "integer" + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" } }, "required": [ - "count", - "offset", - "total" + "rules", + "userGroups", + "users" ], "type": "object" }, - "Parameter": { + "LabelPermissionsAssignment": { + "description": "Desired levels of permissions on a label for an assignee.", "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "name", - "value" + "permissions" ], "type": "object" }, - "ParameterDefinition": { - "description": "Parameter content (type-discriminated).", - "discriminator": { - "mapping": { - "NUMBER": "#/components/schemas/NumberParameterDefinition", - "STRING": "#/components/schemas/StringParameterDefinition" - }, - "propertyName": "type" - }, - "oneOf": [ + "LabelPermissionsForAssignee": { + "allOf": [ { - "$ref": "#/components/schemas/NumberParameterDefinition" + "$ref": "#/components/schemas/LabelPermissionsAssignment" }, { - "$ref": "#/components/schemas/StringParameterDefinition" + "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" }, - "ParameterItem": { - "additionalProperties": true, - "description": "(EXPERIMENTAL) Parameter value for this execution.", - "properties": { - "parameter": { - "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + "LabelPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsAssignment" }, - "value": { - "description": "Value to use for this parameter instead of its default.", - "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": [ - "parameter", - "value" + "assigneeRule", + "permissions" ], "type": "object" }, - "ParameterValue": { - "additionalProperties": true, - "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", - "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", - "type": "string" - }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" + "ListLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/ObjectLinks" }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" + { + "properties": { + "next": { + "description": "A string containing the link's URL for the next page of data.", + "format": "uri", + "type": "string" + } + }, + "type": "object" } - }, - "required": [ - "id", - "title", - "value" - ], - "type": "object" + ] }, - "PartitionConfig": { - "description": "Partition configuration for the table.", - "discriminator": { - "mapping": { - "column": "#/components/schemas/ColumnPartitionConfig", - "dateTrunc": "#/components/schemas/DateTruncPartitionConfig", - "timeSlice": "#/components/schemas/TimeSlicePartitionConfig" - }, - "propertyName": "type" - }, + "ListLlmProviderModelsRequest": { "properties": { - "type": { - "type": "string" + "providerConfig": { + "$ref": "#/components/schemas/LlmProviderConfig" } }, "required": [ - "type" + "providerConfig" ], "type": "object" }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], + "ListLlmProviderModelsResponse": { "properties": { - "properties": { - "description": "List of CSS properties.", + "message": { + "description": "Message about the listing result.", + "type": "string" + }, + "models": { + "description": "Available models on the provider.", "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" + "$ref": "#/components/schemas/LlmModel" }, "type": "array" }, - "selector": { - "description": "CSS selector where to apply given properties.", - "type": "string" + "success": { + "description": "Whether the model listing succeeded.", + "type": "boolean" } }, "required": [ - "selector" + "message", + "models", + "success" ], "type": "object" }, - "PdfTableStyleProperty": { - "description": "CSS property.", + "LiveFeatureFlagConfiguration": { "properties": { - "key": { - "description": "CSS property key.", + "host": { "type": "string" }, - "value": { - "description": "CSS property value.", + "key": { "type": "string" } }, "required": [ - "key", - "value" + "host", + "key" ], "type": "object" }, - "PdmLdmRequest": { - "description": "PDM additions wrapper.", - "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" + "LiveFeatures": { + "allOf": [ + { + "$ref": "#/components/schemas/Features" }, - "tables": { - "description": "List of physical database tables.", - "items": { - "$ref": "#/components/schemas/DeclarativeTable" + { + "properties": { + "configuration": { + "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" + } }, - "type": "array" + "type": "object" } - }, + ], + "description": "Structure for featureHub", + "required": [ + "configuration", + "context" + ], "type": "object" }, - "PdmSql": { - "description": "SQL dataset definition.", + "LlmModel": { + "description": "LLM Model configuration (id, family) within a provider.", "properties": { - "columns": { - "description": "Columns defining SQL dataset.", - "items": { - "$ref": "#/components/schemas/SqlColumn" - }, - "type": "array" - }, - "statement": { - "description": "SQL statement.", - "example": "select * from abc", + "family": { + "description": "Family of LLM models.", + "enum": [ + "OPENAI", + "ANTHROPIC", + "META", + "MISTRAL", + "AMAZON", + "GOOGLE", + "COHERE", + "UNKNOWN" + ], "type": "string" }, - "title": { - "description": "SQL dataset title.", - "example": "My special dataset", + "id": { + "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", + "maxLength": 255, "type": "string" } }, "required": [ - "statement", - "title" + "family", + "id" ], "type": "object" }, - "PendingOperation": { - "allOf": [ + "LlmProviderConfig": { + "description": "Provider configuration overrides.", + "oneOf": [ { - "$ref": "#/components/schemas/Operation" + "$ref": "#/components/schemas/AnthropicProviderConfig" + }, + { + "$ref": "#/components/schemas/AwsBedrockProviderConfig" + }, + { + "$ref": "#/components/schemas/AzureFoundryProviderConfig" + }, + { + "$ref": "#/components/schemas/OpenAIProviderConfig" } - ], - "description": "Operation that is still pending", + ] + }, + "LocalIdentifier": { "properties": { - "status": { - "enum": [ - "pending" - ], + "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": [ - "id", - "kind", - "status" + "localIdentifier" ], "type": "object" }, - "PermissionsAssignment": { + "LocaleRequest": { "properties": { - "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" + "locale": { + "description": "Requested locale in the form of language tag (see RFC 5646).", + "example": "en-US", + "type": "string" } }, "required": [ - "assignees" + "locale" ], "type": "object" }, - "PermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" - }, - { + "MatchAttributeFilter": { + "description": "Filter via label with given match type and literal value.", + "properties": { + "matchAttributeFilter": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "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" + }, + "localIdentifier": { + "type": "string" + }, + "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" ], - "description": "Desired levels of permissions for an assignee identified by an identifier.", + "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": [ - "assigneeIdentifier", - "permissions" + "host", + "siteId" ], "type": "object" }, - "PermissionsForAssigneeRule": { - "allOf": [ + "MeasureDefinition": { + "description": "Abstract metric definition type", + "oneOf": [ { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" + "$ref": "#/components/schemas/InlineMeasureDefinition" }, { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" + "$ref": "#/components/schemas/ArithmeticMeasureDefinition" + }, + { + "$ref": "#/components/schemas/SimpleMeasureDefinition" + }, + { + "$ref": "#/components/schemas/PopMeasureDefinition" } ], - "description": "Desired levels of permissions for a collection of assignees identified by a rule.", + "type": "object" + }, + "MeasureExecutionResultHeader": { + "properties": { + "measureHeader": { + "$ref": "#/components/schemas/MeasureResultHeader" + } + }, "required": [ - "assigneeRule", - "permissions" + "measureHeader" ], "type": "object" }, - "PipeTable": { - "description": "Full details of a pipe-backed OLAP table", + "MeasureGroupHeaders": { + "description": "Measure group headers", "properties": { - "columns": { - "description": "Inferred column schema", - "items": { - "$ref": "#/components/schemas/ColumnInfo" - }, - "type": "array" - }, - "databaseName": { - "description": "Database name", - "type": "string" - }, - "distributionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/HashDistributionConfig" - }, - { - "$ref": "#/components/schemas/RandomDistributionConfig" - } - ] - }, - "keyConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/AggregateKeyConfig" - }, - { - "$ref": "#/components/schemas/DuplicateKeyConfig" - }, - { - "$ref": "#/components/schemas/PrimaryKeyConfig" - }, - { - "$ref": "#/components/schemas/UniqueKeyConfig" - } - ] - }, - "partitionColumns": { - "description": "Hive partition columns detected from the path structure", + "measureGroupHeaders": { "items": { - "description": "Hive partition columns detected from the path structure", - "type": "string" + "$ref": "#/components/schemas/MeasureHeader" }, "type": "array" - }, - "partitionConfig": { - "oneOf": [ - { - "$ref": "#/components/schemas/ColumnPartitionConfig" - }, - { - "$ref": "#/components/schemas/DateTruncPartitionConfig" - }, - { - "$ref": "#/components/schemas/TimeSlicePartitionConfig" - } - ] - }, - "pathPrefix": { - "description": "Path prefix to the parquet files", - "type": "string" - }, - "pipeTableId": { - "description": "Internal UUID of the pipe table record", + } + }, + "type": "object" + }, + "MeasureHeader": { + "properties": { + "format": { + "description": "Format to be used to format the measure data.", "type": "string" }, - "pollingIntervalSeconds": { - "description": "How often (in seconds) the pipe polls for new files. 0 = server default.", - "format": "int32", - "type": "integer" - }, - "sourceStorageName": { - "description": "Source ObjectStorage name", + "localIdentifier": { + "description": "Local identifier of the measure this header relates to.", "type": "string" }, - "tableName": { - "description": "OLAP table name", + "name": { + "description": "Name of the measure.", "type": "string" - }, - "tableProperties": { - "additionalProperties": { - "description": "CREATE TABLE PROPERTIES key-value pairs", - "type": "string" - }, - "description": "CREATE TABLE PROPERTIES key-value pairs", - "type": "object" } }, "required": [ - "columns", - "databaseName", - "distributionConfig", - "keyConfig", - "partitionColumns", - "pathPrefix", - "pipeTableId", - "pollingIntervalSeconds", - "sourceStorageName", - "tableName", - "tableProperties" + "localIdentifier" ], "type": "object" }, - "PipeTableSummary": { - "description": "Lightweight pipe table entry used in list responses", + "MeasureItem": { + "description": "Metric is a quantity that is calculated from the data.", "properties": { - "columns": { - "description": "Inferred column schema", - "items": { - "$ref": "#/components/schemas/ColumnInfo" - }, - "type": "array" - }, - "pathPrefix": { - "description": "Path prefix to the parquet files", - "type": "string" - }, - "pipeTableId": { - "description": "Internal UUID of the pipe table record", - "type": "string" + "definition": { + "$ref": "#/components/schemas/MeasureDefinition" }, - "tableName": { - "description": "OLAP table name", + "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": [ - "columns", - "pathPrefix", - "pipeTableId", - "tableName" + "definition", + "localIdentifier" ], "type": "object" }, - "PlatformUsage": { + "MeasureResultHeader": { + "description": "Header containing the information related to metrics.", "properties": { - "count": { + "measureIndex": { + "description": "Metric index. Starts at 0.", + "example": 0, "format": "int32", "type": "integer" - }, - "name": { - "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" - ], - "type": "string" } }, "required": [ - "name" + "measureIndex" ], "type": "object" }, - "PlatformUsageRequest": { + "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" + }, + { + "$ref": "#/components/schemas/RangeMeasureValueFilter" + }, + { + "$ref": "#/components/schemas/CompoundMeasureValueFilter" + } + ], + "type": "object" + }, + "MemoryItemCreatedByUsers": { "properties": { - "usageItemNames": { + "reasoning": { + "description": "Reasoning for error states", + "type": "string" + }, + "users": { + "description": "Users who created memory item", "items": { - "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" - ], - "type": "string" + "$ref": "#/components/schemas/MemoryItemUser" }, - "type": "array", - "uniqueItems": true + "type": "array" } }, "required": [ - "usageItemNames" + "reasoning", + "users" ], "type": "object" }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "MemoryItemUser": { + "description": "Users who created memory item", "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + "firstname": { + "description": "First name of the user who created memory item", + "type": "string" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "lastname": { + "description": "Last name of the user who created memory item", + "type": "string" + }, + "userId": { + "description": "User ID of the user who created memory item", + "type": "string" } }, "required": [ - "dataset", - "periodsAgo" + "firstname", + "lastname", + "userId" ], "type": "object" }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", "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" + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" } }, "required": [ - "previousPeriodMeasure" + "definition", + "item" ], "type": "object" }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "MetricPermissions": { "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "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": [ - "attribute", - "periodsAgo" + "rules", + "userGroups", + "users" ], "type": "object" }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", + "MetricPermissionsAssignment": { + "description": "Desired levels of permissions on a metric for an assignee.", "properties": { - "overPeriodMeasure": { + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "permissions" + ], + "type": "object" + }, + "MetricPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" + }, + { "properties": { - "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" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" } }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], "type": "object" } - }, + ], + "description": "Desired levels of metric permissions for an assignee identified by an identifier.", "required": [ - "overPeriodMeasure" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "PopMeasureDefinition": { - "oneOf": [ + "MetricPermissionsForAssigneeRule": { + "allOf": [ { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" + "$ref": "#/components/schemas/MetricPermissionsAssignment" }, { - "$ref": "#/components/schemas/PopDateMeasureDefinition" + "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": { + "type": "string" + }, + "value": { + "format": "double", + "type": "number" } + }, + "required": [ + "value" ], "type": "object" }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", + "MetricValueChange": { + "description": "Individual change analysis data item", "properties": { - "positiveAttributeFilter": { + "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": [ + "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.", + "type": "string" + }, + "modelId": { + "description": "The model ID that was tested.", + "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" }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" - }, "label": { "$ref": "#/components/schemas/AfmIdentifier" }, "localIdentifier": { "type": "string" }, + "notIn": { + "$ref": "#/components/schemas/AttributeFilterElements" + }, "usesArbitraryValues": { - "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", + "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", "type": "boolean" } }, "required": [ - "in", - "label" + "label", + "notIn" ], "type": "object" } }, "required": [ - "positiveAttributeFilter" + "negativeAttributeFilter" ], "type": "object" }, - "PrimaryKeyConfig": { - "description": "Primary key model — enforces uniqueness, replaces on conflict.", + "Note": { "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" - }, - "type": { + "appliesTo": { "enum": [ - "primary" + "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 + } } }, - "required": [ - "type" - ], - "type": "object" + "type": "object", + "xml": { + "name": "note", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, - "Profile": { + "Notes": { "properties": { - "entitlements": { - "description": "Defines entitlements for given organization.", + "note": { "items": { - "$ref": "#/components/schemas/ApiEntitlement" + "$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": { + "type": "string" }, - "features": { + "createdAt": { + "format": "date-time", + "type": "string" + }, + "data": { "oneOf": [ { - "$ref": "#/components/schemas/LiveFeatures" + "$ref": "#/components/schemas/AutomationNotification" }, { - "$ref": "#/components/schemas/StaticFeatures" + "$ref": "#/components/schemas/TestNotification" } ] }, - "links": { - "$ref": "#/components/schemas/ProfileLinks" - }, - "name": { - "type": "string" - }, - "organizationId": { - "type": "string" - }, - "organizationName": { + "id": { "type": "string" }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" - }, - "type": "array" - }, - "telemetryConfig": { - "$ref": "#/components/schemas/TelemetryConfig" + "isRead": { + "type": "boolean" }, - "userId": { + "workspaceId": { "type": "string" } }, "required": [ - "entitlements", - "features", - "links", - "organizationId", - "organizationName", - "permissions", - "telemetryConfig", - "userId" + "createdAt", + "data", + "id", + "isRead" ], "type": "object" }, - "ProfileLinks": { - "properties": { - "organization": { - "type": "string" + "NotificationChannelDestination": { + "oneOf": [ + { + "$ref": "#/components/schemas/Webhook" }, - "self": { - "type": "string" + { + "$ref": "#/components/schemas/Smtp" }, - "user": { - "type": "string" + { + "$ref": "#/components/schemas/DefaultSmtp" + }, + { + "$ref": "#/components/schemas/InPlatform" } - }, - "required": [ - "organization", - "self", - "user" ], "type": "object" }, - "ProvisionDatabaseInstanceRequest": { - "description": "Request to provision a new AILake Database instance", - "properties": { - "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" + "NotificationContent": { + "discriminator": { + "mapping": { + "AUTOMATION": "#/components/schemas/AutomationNotification", + "TEST": "#/components/schemas/TestNotification" }, - "name": { - "description": "Name of the database instance", + "propertyName": "type" + }, + "properties": { + "type": { "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": [ - "name", - "storageIds" + "type" ], "type": "object" }, - "QualityIssue": { - "description": "List of quality issues (available when status is COMPLETED)", + "NotificationFilter": { "properties": { - "code": { - "description": "Quality issue code", - "example": "SIMILAR_NAMES", - "type": "string" - }, - "detail": { - "additionalProperties": { - "description": "Detailed information about the quality issue", - "type": "object" - }, - "description": "Detailed information about the quality issue", - "type": "object" - }, - "id": { - "description": "Unique identifier for the quality issue", + "filter": { "type": "string" }, - "objects": { - "description": "List of objects affected by this quality issue", - "items": { - "$ref": "#/components/schemas/QualityIssueObject" - }, - "type": "array" - }, - "severity": { - "description": "Severity level", - "enum": [ - "WARNING", - "INFO" - ], + "title": { "type": "string" } }, "required": [ - "code", - "detail", - "id", - "objects", - "severity" + "filter", + "title" ], "type": "object" }, - "QualityIssueObject": { - "description": "List of objects affected by this quality issue", + "NotificationParameter": { "properties": { "id": { - "description": "Object ID", - "example": "revenue", "type": "string" }, "title": { - "description": "Object title", - "example": "Total Revenue", "type": "string" }, - "type": { - "description": "Object type", - "example": "metric", + "value": { "type": "string" }, - "workspaceId": { - "description": "Workspace ID where the object belongs", - "example": "demo", + "valueTitle": { "type": "string" } }, "required": [ "id", - "title", - "type", - "workspaceId" + "value" ], "type": "object" }, - "QualityIssuesCalculationStatusResponse": { + "Notifications": { "properties": { - "error": { - "description": "Error message (available when status is FAILED or NOT_FOUND)", - "type": "string" - }, - "issues": { - "description": "List of quality issues (available when status is COMPLETED)", + "data": { "items": { - "$ref": "#/components/schemas/QualityIssue" + "$ref": "#/components/schemas/Notification" }, "type": "array" }, - "status": { - "description": "Current status of the calculation", - "enum": [ - "RUNNING", - "SYNCING", - "COMPLETED", - "FAILED", - "CANCELLED", - "NOT_FOUND", - "DISABLED" - ], - "type": "string" + "meta": { + "$ref": "#/components/schemas/NotificationsMeta" } }, "required": [ - "status" + "data", + "meta" ], "type": "object" }, - "RandomDistributionConfig": { - "description": "Random distribution across buckets.", + "NotificationsMeta": { + "properties": { + "total": { + "$ref": "#/components/schemas/NotificationsMetaTotal" + } + }, + "type": "object" + }, + "NotificationsMetaTotal": { "properties": { - "buckets": { - "description": "Number of random distribution buckets. Defaults to 1.", - "format": "int32", - "minimum": 1, + "all": { + "format": "int64", "type": "integer" }, - "type": { - "enum": [ - "random" - ], - "type": "string" + "unread": { + "format": "int64", + "type": "integer" } }, "required": [ - "type" + "all", + "unread" ], "type": "object" }, - "Range": { + "NumberConstraints": { "properties": { - "from": { - "$ref": "#/components/schemas/Value" + "max": { + "format": "double", + "type": "number" }, - "measure": { - "$ref": "#/components/schemas/LocalIdentifier" + "min": { + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "NumberParameterDefinition": { + "properties": { + "constraints": { + "$ref": "#/components/schemas/NumberConstraints" }, - "operator": { + "defaultValue": { + "format": "double", + "type": "number" + }, + "type": { + "description": "The parameter type.", "enum": [ - "BETWEEN", - "NOT_BETWEEN" + "NUMBER" ], "type": "string" - }, - "to": { - "$ref": "#/components/schemas/Value" } }, "required": [ - "from", - "measure", - "operator", - "to" + "defaultValue", + "type" ], "type": "object" }, - "RangeCondition": { - "description": "Condition that checks if the metric value is within a given range.", + "ObjectConditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this object.", + "nullable": true, "properties": { - "range": { - "properties": { - "from": { - "example": 100, - "type": "number" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - } + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" }, - "required": [ - "from", - "operator", - "to" - ], - "type": "object" + "type": "array" + }, + "enabled": { + "description": "Whether the conditions are applied when rendering.", + "type": "boolean" } }, "required": [ - "range" + "conditions", + "enabled" ], "type": "object" }, - "RangeMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given range of values.", + "ObjectLinks": { "properties": { - "rangeMeasureValueFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "from": { - "example": 100, - "type": "number" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" - } + "self": { + "description": "A string containing the link's URL.", + "format": "uri", + "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", + "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" }, - "required": [ - "from", - "measure", - "operator", - "to" - ], + "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", "type": "object" + }, + "storageId": { + "description": "Stable identifier of the storage configuration (UUID).", + "type": "string" + }, + "storageType": { + "description": "Provider type.", + "example": "s3", + "type": "string" } }, "required": [ - "rangeMeasureValueFilter" + "name", + "storageConfig", + "storageId", + "storageType" ], "type": "object" }, - "RangeWrapper": { + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", "properties": { - "range": { - "$ref": "#/components/schemas/Range" + "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.", + "enum": [ + "OPENAI" + ], + "type": "string" } }, "required": [ - "range" + "auth", + "type" ], "type": "object" }, - "RankingFilter": { - "description": "Filter the result on top/bottom N values according to given metric(s).", - "properties": { - "rankingFilter": { + "OpenAiApiKeyAuth": { + "allOf": [ + { "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measures": { - "description": "References to the metrics to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" + "apiKey": { + "description": "OpenAI API key.", + "maxLength": 255, + "nullable": true, + "type": "string", + "writeOnly": true }, - "operator": { - "description": "The type of ranking to use, TOP or BOTTOM.", + "type": { + "description": "Authentication type.", "enum": [ - "TOP", - "BOTTOM" + "API_KEY" ], "type": "string" - }, - "strictLimitOfRows": { - "description": "When true, filter returns requested number of rows at most. Default is false.", - "type": "boolean" - }, - "value": { - "description": "Number of top/bottom values to filter.", - "example": 5, - "format": "int32", - "type": "integer" } }, - "required": [ - "measures", - "operator", - "value" - ], "type": "object" } - }, + ], "required": [ - "rankingFilter" + "type" ], "type": "object" }, - "RawCustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", - "type": "string" + "OpenAiProviderAuth": { + "description": "Authentication configuration.", + "oneOf": [ + { + "$ref": "#/components/schemas/OpenAiApiKeyAuth" } - }, - "required": [ - "title" ], "type": "object" }, - "RawCustomMetric": { - "description": "Custom metric object override.", + "OpenTelemetryService": { + "description": "OpenTelemetry service.", "properties": { - "title": { - "description": "Metric title override.", + "host": { + "description": "Telemetry host to send events to.", "type": "string" } }, "required": [ - "title" + "host" ], "type": "object" }, - "RawCustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", - "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomLabel" - }, - "description": "Map of CustomLabels with keys used as placeholders in export result.", - "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" }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomMetric" - }, - "description": "Map of CustomMetrics with keys used as placeholders in export result.", - "type": "object" - } + "propertyName": "status" }, - "type": "object" - }, - "RawExportAutomationRequest": { - "description": "Export request object describing the export properties and overrides for raw exports.", "properties": { - "customOverride": { - "$ref": "#/components/schemas/RawCustomOverride" - }, - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", - "type": "string" - }, - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", + "id": { + "description": "Id of the operation", "type": "string" }, - "format": { - "description": "Requested resulting file 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": [ - "ARROW_FILE", - "ARROW_STREAM", - "CSV" + "provision-database", + "deprovision-database", + "run-service-command", + "analyze-statistics" ], - "example": "CSV", "type": "string" }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" + "status": { + "type": "string" } }, "required": [ - "execution", - "fileName", - "format" + "id", + "kind", + "status" ], "type": "object" }, - "RawExportRequest": { - "description": "Export request object describing the export properties and overrides for raw exports.", + "OperationError": { + "description": "Error information for a failed operation", "properties": { - "customOverride": { - "$ref": "#/components/schemas/RawCustomOverride" - }, - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", + "detail": { + "description": "Human-readable error details", "type": "string" }, - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" + "status": { + "description": "HTTP status code", + "format": "int32", + "type": "integer" }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "ARROW_FILE", - "ARROW_STREAM", - "CSV" - ], - "example": "CSV", + "title": { + "description": "Human-readable error name", "type": "string" } }, "required": [ - "execution", - "fileName", - "format" + "detail", + "status", + "title" ], "type": "object" }, - "ReadCsvFileManifestsRequest": { - "description": "Request to read the manifests of the specified CSV files.", + "OrganizationAutomationIdentifier": { "properties": { - "manifestRequests": { - "description": "Files to read the manifests for.", - "items": { - "$ref": "#/components/schemas/ReadCsvFileManifestsRequestItem" - }, - "type": "array" + "id": { + "type": "string" + }, + "workspaceId": { + "type": "string" } }, "required": [ - "manifestRequests" + "id", + "workspaceId" ], "type": "object" }, - "ReadCsvFileManifestsRequestItem": { - "description": "Request to read the manifest of a single CSV file.", + "OrganizationAutomationManagementBulkRequest": { "properties": { - "fileName": { - "description": "Name of the CSV file to read the manifest for.", - "type": "string" - }, - "version": { - "description": "Optional version of the file to read the manifest for. If null or not specified, the latest version is read.", - "format": "int32", - "type": "integer" + "automations": { + "items": { + "$ref": "#/components/schemas/OrganizationAutomationIdentifier" + }, + "type": "array" } }, "required": [ - "fileName" + "automations" ], "type": "object" }, - "ReadCsvFileManifestsResponse": { - "description": "Describes the results of a CSV manifest read of a single file.", + "OrganizationCacheSettings": { + "description": "Settings for organization cache.", "properties": { - "manifest": { - "$ref": "#/components/schemas/CsvManifestBody" - }, - "name": { - "description": "Name of the file in the source data source.", - "type": "string" - }, - "version": { - "description": "Version of the file in the source data source.", - "format": "int32", + "extraCacheBudget": { + "description": "Extra cache budget the organization can allocate among its workspaces, in bytes.", + "format": "int64", "type": "integer" } }, "required": [ - "manifest", - "name", - "version" + "extraCacheBudget" ], "type": "object" }, - "Reasoning": { - "description": "Reasoning wrapper containing steps taken during request handling.", + "OrganizationCacheUsage": { + "description": "Data about the whole organization's cache usage.", "properties": { - "answer": { - "description": "Final answer/reasoning from the use case result.", - "type": "string" + "current": { + "$ref": "#/components/schemas/OrganizationCurrentCacheUsage" }, - "steps": { - "description": "Steps taken during processing, showing the AI's reasoning process.", + "removalIntervals": { + "description": "List of cache removal intervals.", "items": { - "$ref": "#/components/schemas/ReasoningStep" + "$ref": "#/components/schemas/CacheRemovalInterval" }, "type": "array" + }, + "settings": { + "$ref": "#/components/schemas/OrganizationCacheSettings" } }, "required": [ - "steps" + "current", + "removalIntervals", + "settings" ], "type": "object" }, - "ReasoningStep": { - "description": "Steps taken during processing, showing the AI's reasoning process.", + "OrganizationCurrentCacheUsage": { + "description": "Current cache usage of the organization.", "properties": { - "thoughts": { - "description": "Detailed thoughts/messages within this step.", - "items": { - "$ref": "#/components/schemas/Thought" - }, - "type": "array" + "cacheUsed": { + "description": "Cache currently used by the organization, in bytes.", + "format": "int64", + "type": "integer" }, - "title": { - "description": "Title describing this reasoning step.", + "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": [ - "thoughts", - "title" + "cacheUsed", + "removedSinceStart" ], "type": "object" }, - "ReferenceIdentifier": { - "description": "A reference identifier.", + "OrganizationPermissionAssignment": { + "description": "Organization permission assignments", "properties": { - "id": { - "description": "Reference ID.", - "example": "customers", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" }, - "type": { - "description": "A type of the reference.", - "enum": [ - "dataset" - ], - "example": "DATASET", - "type": "string" + "permissions": { + "items": { + "enum": [ + "MANAGE", + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "type" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "ReferenceSourceColumn": { + "OutlierDetectionRequest": { "properties": { - "column": { - "type": "string" + "attributes": { + "description": "Attributes to be used in the computation.", + "items": { + "$ref": "#/components/schemas/AttributeItem" + }, + "type": "array" }, - "dataType": { + "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": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN", - "HLL" + "HOUR", + "DAY", + "WEEK", + "MONTH", + "QUARTER", + "YEAR" ], "type": "string" }, - "isNullable": { - "type": "boolean" + "measures": { + "items": { + "$ref": "#/components/schemas/MeasureItem" + }, + "minItems": 1, + "type": "array" }, - "nullValue": { + "sensitivity": { + "description": "Sensitivity level for outlier detection", + "enum": [ + "LOW", + "MEDIUM", + "HIGH" + ], "type": "string" - }, - "target": { - "$ref": "#/components/schemas/DatasetGrain" } }, "required": [ - "target" + "attributes", + "granularity", + "measures", + "sensitivity" ], "type": "object" }, - "RefreshPartitionRequest": { - "description": "Request to refresh a specific Hive partition in a pipe-backed OLAP table", + "OutlierDetectionResponse": { "properties": { - "partitionSpec": { - "additionalProperties": { - "description": "Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"}", + "links": { + "$ref": "#/components/schemas/ExecutionLinks" + } + }, + "required": [ + "links" + ], + "type": "object" + }, + "OutlierDetectionResult": { + "properties": { + "attribute": { + "description": "Attribute values for outlier detection results.", + "items": { "type": "string" }, - "description": "Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"}", + "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, + "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": [ - "partitionSpec" + "attribute", + "values" ], "type": "object" }, - "Relative": { + "Over": { "properties": { - "measure": { - "$ref": "#/components/schemas/ArithmeticMeasure" - }, - "operator": { - "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", - "enum": [ - "INCREASES_BY", - "DECREASES_BY", - "CHANGES_BY" - ], - "type": "string" - }, - "threshold": { - "$ref": "#/components/schemas/Value" + "attributes": { + "items": { + "$ref": "#/components/schemas/IdentifierRef" + }, + "type": "array" } }, "required": [ - "measure", - "operator", - "threshold" + "attributes" ], "type": "object" }, - "RelativeBoundedDateFilter": { + "PageMetadata": { "properties": { - "from": { + "number": { + "description": "The number of the current page", "format": "int32", "type": "integer" }, - "granularity": { - "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.minute_in_day", - "GDC.time.second", - "GDC.time.second_in_minute", - "GDC.time.second_in_day", - "GDC.time.fiscal_week", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_semester", - "GDC.time.fiscal_year", - "GDC.time.fiscal_day_in_fiscal_week", - "GDC.time.fiscal_day_in_fiscal_month", - "GDC.time.fiscal_day_in_fiscal_quarter", - "GDC.time.fiscal_day_in_fiscal_semester", - "GDC.time.fiscal_day_in_fiscal_year", - "GDC.time.fiscal_week_in_fiscal_month", - "GDC.time.fiscal_week_in_fiscal_quarter", - "GDC.time.fiscal_week_in_fiscal_semester", - "GDC.time.fiscal_week_in_fiscal_year", - "GDC.time.fiscal_month_in_fiscal_quarter", - "GDC.time.fiscal_month_in_fiscal_semester", - "GDC.time.fiscal_month_in_fiscal_year", - "GDC.time.fiscal_quarter_in_fiscal_semester", - "GDC.time.fiscal_quarter_in_fiscal_year", - "GDC.time.fiscal_semester_in_fiscal_year" - ], - "type": "string" + "size": { + "description": "The size of the current page", + "format": "int32", + "type": "integer" }, - "to": { + "totalElements": { + "description": "The total number of elements", + "format": "int32", + "type": "integer" + }, + "totalPages": { + "description": "The total number of pages", "format": "int32", "type": "integer" } }, - "required": [ - "granularity" - ], "type": "object" }, - "RelativeDateFilter": { - "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "Paging": { + "description": "Current page description.", "properties": { - "relativeDateFilter": { - "properties": { - "applyOnResult": { - "type": "boolean" - }, - "boundedFilter": { - "$ref": "#/components/schemas/BoundedFilter" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "emptyValueHandling": { - "default": "EXCLUDE", - "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", - "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" - ], - "type": "string" - }, - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", - "example": -6, - "format": "int32", - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "SECOND", - "SECOND_OF_MINUTE", - "SECOND_OF_DAY", - "MINUTE", - "MINUTE_OF_HOUR", - "MINUTE_OF_DAY", - "HOUR", - "HOUR_OF_DAY", - "DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK", - "WEEK_OF_YEAR", - "MONTH", - "MONTH_OF_YEAR", - "QUARTER", - "QUARTER_OF_YEAR", - "YEAR", - "FISCAL_DAY_OF_FISCAL_WEEK", - "FISCAL_DAY_OF_FISCAL_MONTH", - "FISCAL_DAY_OF_FISCAL_QUARTER", - "FISCAL_DAY_OF_FISCAL_SEMESTER", - "FISCAL_DAY_OF_FISCAL_YEAR", - "FISCAL_WEEK", - "FISCAL_WEEK_OF_FISCAL_MONTH", - "FISCAL_WEEK_OF_FISCAL_QUARTER", - "FISCAL_WEEK_OF_FISCAL_SEMESTER", - "FISCAL_WEEK_OF_FISCAL_YEAR", - "FISCAL_MONTH", - "FISCAL_MONTH_OF_FISCAL_QUARTER", - "FISCAL_MONTH_OF_FISCAL_SEMESTER", - "FISCAL_MONTH_OF_FISCAL_YEAR", - "FISCAL_QUARTER", - "FISCAL_QUARTER_OF_FISCAL_SEMESTER", - "FISCAL_QUARTER_OF_FISCAL_YEAR", - "FISCAL_SEMESTER", - "FISCAL_SEMESTER_OF_FISCAL_YEAR", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" - }, - "localIdentifier": { - "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", - "example": 0, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "dataset", - "from", - "granularity", - "to" - ], - "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" + }, + "total": { + "description": "Count of returnable items ignoring paging.", + "example": 100, + "format": "int32", + "type": "integer" } }, "required": [ - "relativeDateFilter" + "count", + "offset", + "total" ], "type": "object" }, - "RelativeWrapper": { + "Parameter": { "properties": { - "relative": { - "$ref": "#/components/schemas/Relative" + "name": { + "type": "string" + }, + "value": { + "type": "string" } }, "required": [ - "relative" + "name", + "value" ], "type": "object" }, - "RemoveDatabaseDataSourceResponse": { - "description": "Confirmation of data source removal from an AI Lake Database instance", - "properties": { - "dataSourceId": { - "description": "Identifier of the removed data source in metadata-api.", - "type": "string" - } + "ParameterDefinition": { + "description": "Parameter content (type-discriminated).", + "discriminator": { + "mapping": { + "NUMBER": "#/components/schemas/NumberParameterDefinition", + "STRING": "#/components/schemas/StringParameterDefinition" + }, + "propertyName": "type" }, - "required": [ - "dataSourceId" + "oneOf": [ + { + "$ref": "#/components/schemas/NumberParameterDefinition" + }, + { + "$ref": "#/components/schemas/StringParameterDefinition" + } ], "type": "object" }, - "ResolveSettingsRequest": { - "description": "A request containing setting IDs to resolve.", + "ParameterItem": { + "additionalProperties": true, + "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { - "settings": { - "description": "An array of setting IDs to resolve.", - "example": [ - "timezone" - ], - "items": { - "type": "string" - }, - "type": "array" + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + }, + "value": { + "description": "Value to use for this parameter instead of its default.", + "type": "string" } }, "required": [ - "settings" + "parameter", + "value" ], "type": "object" }, - "ResolvedLlm": { - "description": "The resolved LLM configuration, or null if none is configured.", + "ParameterValue": { + "additionalProperties": true, + "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", "properties": { "id": { + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", "type": "string" }, "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", + "type": "string" + }, + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" + }, + "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" + "title", + "value" ], "type": "object" }, - "ResolvedLlmProvider": { - "allOf": [ - { - "$ref": "#/components/schemas/ResolvedLlm" - }, + "PdfTableStyle": { + "deprecated": true, + "description": "Custom CSS styles for the table. (PDF, HTML)", + "example": [ { - "properties": { - "id": { - "description": "Provider Id", - "type": "string" - }, - "models": { - "items": { - "$ref": "#/components/schemas/LlmModel" - }, - "maxItems": 1, - "minItems": 1, - "type": "array" - }, - "title": { - "description": "Provider Title", - "type": "string" + "properties": [ + { + "key": "font-size", + "value": "30px" } - }, - "type": "object" + ], + "selector": "th" } ], + "properties": { + "properties": { + "description": "List of CSS properties.", + "items": { + "$ref": "#/components/schemas/PdfTableStyleProperty" + }, + "type": "array" + }, + "selector": { + "description": "CSS selector where to apply given properties.", + "type": "string" + } + }, "required": [ - "id", - "models", - "title" + "selector" ], "type": "object" }, - "ResolvedLlms": { + "PdfTableStyleProperty": { + "description": "CSS property.", "properties": { - "data": { - "oneOf": [ - { - "$ref": "#/components/schemas/ResolvedLlmProvider" - } - ] + "key": { + "description": "CSS property key.", + "type": "string" + }, + "value": { + "description": "CSS property value.", + "type": "string" } }, + "required": [ + "key", + "value" + ], "type": "object" }, - "ResolvedSetting": { - "description": "Setting and its value.", + "PdmLdmRequest": { + "description": "PDM additions wrapper.", "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "deprecated": true, - "description": "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", - "type": "string" + "sqls": { + "description": "List of SQL datasets.", + "items": { + "$ref": "#/components/schemas/PdmSql" + }, + "type": "array" }, - "type": { - "description": "Type of the setting.", - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], - "example": "TIMEZONE", - "type": "string" + "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" } }, - "required": [ - "id" - ], "type": "object" }, - "RestApiIdentifier": { - "description": "Object identifier.", + "PdmSql": { + "description": "SQL dataset definition.", "properties": { - "id": { - "example": "sample_item.price", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "columns": { + "description": "Columns defining SQL dataset.", + "items": { + "$ref": "#/components/schemas/SqlColumn" + }, + "type": "array" + }, + "statement": { + "description": "SQL statement.", + "example": "select * from abc", "type": "string" }, - "type": { - "example": "fact", + "title": { + "description": "SQL dataset title.", + "example": "My special dataset", "type": "string" } }, "required": [ - "id", - "type" + "statement", + "title" ], "type": "object" }, - "ResultCacheMetadata": { - "description": "All execution result's metadata used for calculation including ExecutionResponse", + "PendingOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/Operation" + } + ], + "description": "Operation that is still pending", "properties": { - "afm": { - "$ref": "#/components/schemas/AFM" - }, - "executionResponse": { - "$ref": "#/components/schemas/ExecutionResponse" - }, - "resultSize": { - "format": "int64", - "type": "integer" - }, - "resultSpec": { - "$ref": "#/components/schemas/ResultSpec" + "status": { + "enum": [ + "pending" + ], + "type": "string" } }, "required": [ - "afm", - "executionResponse", - "resultSize", - "resultSpec" + "id", + "kind", + "status" ], "type": "object" }, - "ResultDimension": { - "description": "Single result dimension", + "PermissionsAssignment": { "properties": { - "headers": { + "assignees": { "items": { - "$ref": "#/components/schemas/ResultDimensionHeader" + "$ref": "#/components/schemas/AssigneeIdentifier" }, + "minItems": 1, "type": "array" }, - "localIdentifier": { - "description": "Local identifier of the dimension.", - "type": "string" + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" } }, "required": [ - "headers", - "localIdentifier" + "assignees" ], "type": "object" }, - "ResultDimensionHeader": { - "description": "One of the headers in a result dimension.", - "oneOf": [ + "PermissionsForAssignee": { + "allOf": [ { - "$ref": "#/components/schemas/MeasureGroupHeaders" + "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, { - "$ref": "#/components/schemas/AttributeHeader" - } - ], - "type": "object" - }, - "ResultSpec": { - "description": "Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).", - "properties": { - "dimensions": { - "items": { - "$ref": "#/components/schemas/Dimension" - }, - "type": "array" - }, - "totals": { - "items": { - "$ref": "#/components/schemas/Total" + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } }, - "type": "array" + "type": "object" } - }, + ], + "description": "Desired levels of permissions for an assignee identified by an identifier.", "required": [ - "dimensions" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "RichTextWidgetDescriptor": { - "description": "Rich text widget displaying static content. Has no execution result.", - "properties": { - "content": { - "description": "Markdown/text content of the rich text widget.", - "type": "string" + "PermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, - "filters": { - "description": "Filters currently applied to the dashboard.", - "items": { - "$ref": "#/components/schemas/FilterDefinition" + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } }, - "type": "array" - }, - "title": { - "description": "Widget title as displayed on the dashboard.", - "type": "string" - }, - "widgetId": { - "description": "Widget object ID.", - "type": "string" - }, - "widgetType": { - "enum": [ - "richText" - ], - "type": "string" + "type": "object" } - }, + ], + "description": "Desired levels of permissions for a collection of assignees identified by a rule.", "required": [ - "title", - "widgetId", - "widgetType" + "assigneeRule", + "permissions" ], "type": "object" }, - "RouteResult": { - "description": "Question -> Use Case routing. May contain final answer is a special use case is not required.", + "PlatformUsage": { "properties": { - "reasoning": { - "description": "Explanation why LLM picked this use case.", - "type": "string" + "count": { + "format": "int32", + "type": "integer" }, - "useCase": { - "description": "Use case where LLM routed based on question.", + "name": { "enum": [ - "INVALID", - "GENERAL", - "SEARCH", - "CREATE_VISUALIZATION", - "EXTEND_VISUALIZATION", - "HOWTO", - "CHANGE_ANALYSIS", - "ALERT" + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" ], "type": "string" } }, "required": [ - "reasoning", - "useCase" + "name" ], "type": "object" }, - "RsaSpecification": { + "PlatformUsageRequest": { "properties": { - "alg": { - "enum": [ - "RS256", - "RS384", - "RS512" - ], - "type": "string" - }, - "e": { - "type": "string" - }, - "kid": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[^.]", - "type": "string" - }, - "kty": { - "enum": [ - "RSA" - ], - "type": "string" - }, - "n": { - "type": "string" - }, - "use": { - "enum": [ - "sig" - ], - "type": "string" - }, - "x5c": { + "usageItemNames": { "items": { + "enum": [ + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" + ], "type": "string" }, - "type": "array" - }, - "x5t": { - "type": "string" + "type": "array", + "uniqueItems": true } }, "required": [ - "alg", - "e", - "kid", - "kty", - "n", - "use" + "usageItemNames" ], "type": "object" }, - "RulePermission": { - "description": "List of rules", + "PopDataset": { + "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", "properties": { - "permissions": { - "description": "Permissions granted by the rule", - "items": { - "$ref": "#/components/schemas/GrantedPermission" - }, - "type": "array" + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, - "type": { - "description": "Type of the rule", - "example": "allWorkspaceUsers", - "type": "string" + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" } }, "required": [ - "type" + "dataset", + "periodsAgo" ], "type": "object" }, - "RunServiceCommandRequest": { - "description": "Request to run an AI Lake Service Command", + "PopDatasetMeasureDefinition": { + "description": "Previous period type of metric.", "properties": { - "context": { - "additionalProperties": { - "description": "The context to pass to the command", - "nullable": true, - "type": "string" + "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" + } }, - "description": "The context to pass to the command", - "nullable": true, + "required": [ + "dateDatasets", + "measureIdentifier" + ], "type": "object" - }, - "payload": { - "$ref": "#/components/schemas/JsonNode" - } - }, - "type": "object" - }, - "RunningSection": { - "description": "Footer section of the slide", - "nullable": true, - "properties": { - "left": { - "description": "Either {{logo}} variable or custom text with combination of other variables.", - "nullable": true, - "type": "string" - }, - "right": { - "description": "Either {{logo}} variable or custom text with combination of other variables.", - "nullable": true, - "type": "string" } }, + "required": [ + "previousPeriodMeasure" + ], "type": "object" }, - "SavedVisualization": { - "description": "Created and saved visualization IDs.", + "PopDate": { + "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", "properties": { - "createdVisualizationId": { - "description": "Created visualization ID.", - "type": "string" + "attribute": { + "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, - "savedVisualizationId": { - "description": "Saved visualization ID.", - "type": "string" + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" } }, "required": [ - "createdVisualizationId", - "savedVisualizationId" + "attribute", + "periodsAgo" ], "type": "object" }, - "ScanRequest": { - "description": "A request containing all information critical to model scanning.", + "PopDateMeasureDefinition": { + "description": "Period over period type of metric.", "properties": { - "scanTables": { - "description": "A flag indicating whether the tables should be scanned.", - "example": true, - "type": "boolean" - }, - "scanViews": { - "description": "A flag indicating whether the views should be scanned.", - "example": true, - "type": "boolean" - }, - "schemata": { - "description": "What schemata will be scanned.", - "example": [ - "tpch", - "demo" - ], - "items": { - "type": "string" + "overPeriodMeasure": { + "properties": { + "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" + } }, - "type": "array" - }, - "separator": { - "description": "A separator between prefixes and the names.", - "example": "__", - "type": "string" - }, - "tablePrefix": { - "description": "Tables starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.", - "example": "out_table", - "type": "string" - }, - "viewPrefix": { - "description": "Views starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.", - "example": "out_view", - "type": "string" + "required": [ + "dateAttributes", + "measureIdentifier" + ], + "type": "object" } }, "required": [ - "scanTables", - "scanViews", - "separator" + "overPeriodMeasure" ], "type": "object" }, - "ScanResultPdm": { - "description": "Result of scan of data source physical model.", - "properties": { - "pdm": { - "$ref": "#/components/schemas/DeclarativeTables" + "PopMeasureDefinition": { + "oneOf": [ + { + "$ref": "#/components/schemas/PopDatasetMeasureDefinition" }, - "warnings": { - "items": { - "$ref": "#/components/schemas/TableWarning" - }, - "type": "array" + { + "$ref": "#/components/schemas/PopDateMeasureDefinition" } - }, - "required": [ - "pdm", - "warnings" ], "type": "object" }, - "ScanSqlRequest": { - "description": "A request with SQL query to by analyzed.", + "PositiveAttributeFilter": { + "description": "Filter able to limit element values by label and related selected elements.", "properties": { - "sql": { - "description": "SQL query to be analyzed.", - "example": "SELECT a.special_value as result FROM tableA a", - "type": "string" + "positiveAttributeFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "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": [ - "sql" + "positiveAttributeFilter" ], "type": "object" }, - "ScanSqlResponse": { - "description": "Result of scanSql. Consists of array of query columns including type. Sql query result data preview can be attached optionally", + "Profile": { "properties": { - "columns": { - "description": "Array of columns with types.", + "entitlements": { + "description": "Defines entitlements for given organization.", "items": { - "$ref": "#/components/schemas/SqlColumn" + "$ref": "#/components/schemas/ApiEntitlement" }, "type": "array" }, - "dataPreview": { - "description": "Array of rows where each row is another array of string values.", - "items": { - "items": { - "nullable": true, - "type": "string" + "features": { + "oneOf": [ + { + "$ref": "#/components/schemas/LiveFeatures" }, - "type": "array" + { + "$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" - } - }, - "required": [ - "columns" - ], - "type": "object" - }, - "ScheduleCacheRetention": { - "description": "The cache expires according to a schedule.", - "properties": { - "schedule": { - "$ref": "#/components/schemas/CacheRetentionSchedule" }, - "type": { - "description": "The cache retention type.", - "enum": [ - "SCHEDULE" - ], + "telemetryConfig": { + "$ref": "#/components/schemas/TelemetryConfig" + }, + "userId": { "type": "string" } }, "required": [ - "schedule", - "type" + "entitlements", + "features", + "links", + "organizationId", + "organizationName", + "permissions", + "telemetryConfig", + "userId" ], "type": "object" }, - "SearchRelationshipObject": { + "ProfileLinks": { "properties": { - "sourceObjectId": { - "description": "Source object ID.", - "type": "string" - }, - "sourceObjectTitle": { - "description": "Source object title.", - "type": "string" - }, - "sourceObjectType": { - "description": "Source object type, e.g. dashboard.", - "type": "string" - }, - "sourceWorkspaceId": { - "description": "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.", - "type": "string" - }, - "targetObjectId": { - "description": "Target object ID.", - "type": "string" - }, - "targetObjectTitle": { - "description": "Target object title.", + "organization": { "type": "string" }, - "targetObjectType": { - "description": "Target object type, e.g. visualization.", + "self": { "type": "string" }, - "targetWorkspaceId": { - "description": "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.", + "user": { "type": "string" } }, "required": [ - "sourceObjectId", - "sourceObjectTitle", - "sourceObjectType", - "sourceWorkspaceId", - "targetObjectId", - "targetObjectTitle", - "targetObjectType", - "targetWorkspaceId" + "organization", + "self", + "user" ], "type": "object" }, - "SearchRequest": { + "ProvisionDatabaseInstanceRequest": { + "description": "Request to provision a new AILake Database instance", "properties": { - "allowedRelationshipTypes": { - "description": "Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.", - "items": { - "$ref": "#/components/schemas/AllowedRelationshipType" - }, - "type": "array" - }, - "deepSearch": { - "default": false, - "description": "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.", - "type": "boolean" - }, - "enableHybridSearch": { - "default": false, - "description": "If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.", - "type": "boolean" - }, - "excludeTags": { - "description": "Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.", - "items": { - "description": "Tag to exclude.", - "type": "string" - }, - "type": "array" - }, - "includeHidden": { - "default": false, - "description": "If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.", - "type": "boolean" + "dataSourceId": { + "description": "Identifier for the data source created in metadata-api. Defaults to the database name.", + "type": "string" }, - "includeTags": { - "description": "Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.", - "items": { - "description": "Tag to include.", - "type": "string" - }, - "type": "array" + "dataSourceName": { + "description": "Display name for the data source created in metadata-api. Defaults to the database name.", + "type": "string" }, - "limit": { - "default": 10, - "description": "Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.", - "format": "int32", - "type": "integer" + "name": { + "description": "Name of the database instance", + "type": "string" }, - "objectTypes": { - "description": "List of object types to search for.", + "storageIds": { + "description": "Set of ids of the storage instances this database instance should access.", "items": { - "description": "Object type to search for.", - "enum": [ - "attribute", - "metric", - "fact", - "label", - "date", - "dataset", - "visualization", - "dashboard" - ], + "description": "Set of ids of the storage instances this database instance should access.", "type": "string" }, - "type": "array" - }, - "question": { - "description": "Keyword/sentence is input for search.", - "maxLength": 1000, - "type": "string" - }, - "relevantScoreThreshold": { - "default": 0.3, - "description": "Score, above which we return found objects. Below this score objects are not relevant.", - "format": "double", - "type": "number" - }, - "titleToDescriptorRatio": { - "default": 0.7, - "description": "Temporary for experiments. Ratio of title score to descriptor score.", - "format": "double", - "type": "number" + "type": "array", + "uniqueItems": true } }, "required": [ - "question" + "name", + "storageIds" ], "type": "object" }, - "SearchResult": { + "QualityIssue": { + "description": "List of quality issues (available when status is COMPLETED)", "properties": { - "error": { - "$ref": "#/components/schemas/ErrorInfo" - }, - "reasoning": { - "deprecated": true, - "description": "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", + "code": { + "description": "Quality issue code", + "example": "SIMILAR_NAMES", "type": "string" }, - "relationships": { - "items": { - "$ref": "#/components/schemas/SearchRelationshipObject" + "detail": { + "additionalProperties": { + "description": "Detailed information about the quality issue", + "type": "object" }, - "type": "array" + "description": "Detailed information about the quality issue", + "type": "object" + }, + "id": { + "description": "Unique identifier for the quality issue", + "type": "string" }, - "results": { + "objects": { + "description": "List of objects affected by this quality issue", "items": { - "$ref": "#/components/schemas/SearchResultObject" + "$ref": "#/components/schemas/QualityIssueObject" }, "type": "array" + }, + "severity": { + "description": "Severity level", + "enum": [ + "WARNING", + "INFO" + ], + "type": "string" } }, "required": [ - "reasoning", - "relationships", - "results" + "code", + "detail", + "id", + "objects", + "severity" ], "type": "object" }, - "SearchResultObject": { + "QualityIssueObject": { + "description": "List of objects affected by this quality issue", "properties": { - "certification": { - "$ref": "#/components/schemas/CertificationInfo" - }, - "createdAt": { - "description": "Timestamp when object was created.", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Object description.", - "type": "string" - }, "id": { - "description": "Object ID.", - "type": "string" - }, - "isHidden": { - "description": "If true, this object is hidden from AI search results by default.", - "type": "boolean" - }, - "modifiedAt": { - "description": "Timestamp when object was last modified.", - "format": "date-time", + "description": "Object ID", + "example": "revenue", "type": "string" }, - "score": { - "description": "Result score calculated by a similarity search algorithm (cosine_distance).", - "format": "float", - "type": "number" - }, - "scoreDescriptor": { - "description": "Result score for descriptor containing(now) description and tags.", - "format": "float", - "type": "number" - }, - "scoreExactMatch": { - "description": "Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.", - "format": "int32", - "type": "integer" - }, - "scoreTitle": { - "description": "Result score for object title.", - "format": "float", - "type": "number" - }, - "tags": { - "items": { - "description": "List of tags assigned to the object.", - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, "title": { - "description": "Object title.", + "description": "Object title", + "example": "Total Revenue", "type": "string" }, "type": { - "description": "Object type, e.g. dashboard.", - "type": "string" - }, - "visualizationUrl": { - "description": "If the object is visualization, this field defines the type of visualization.", + "description": "Object type", + "example": "metric", "type": "string" }, "workspaceId": { - "description": "Workspace ID.", + "description": "Workspace ID where the object belongs", + "example": "demo", "type": "string" } }, @@ -36284,555 +40431,430 @@ ], "type": "object" }, - "SectionSlideTemplate": { - "description": "Settings for section slide.", - "nullable": true, - "properties": { - "backgroundImage": { - "default": true, - "description": "Show background image on the slide.", - "type": "boolean" - }, - "footer": { - "$ref": "#/components/schemas/RunningSection" - }, - "header": { - "$ref": "#/components/schemas/RunningSection" - } - }, - "type": "object" - }, - "ServerSentEventChatResult": { - "type": "object" - }, - "ServiceInfo": { - "description": "Non-sensitive metadata for an AI Lake pipeline", + "QualityIssuesCalculationStatusResponse": { "properties": { - "name": { - "description": "Human-readable name of the service", + "error": { + "description": "Error message (available when status is FAILED or NOT_FOUND)", "type": "string" }, - "serviceId": { - "description": "Internal identifier for the service configuration (UUID)", + "issues": { + "description": "List of quality issues (available when status is COMPLETED)", + "items": { + "$ref": "#/components/schemas/QualityIssue" + }, + "type": "array" + }, + "status": { + "description": "Current status of the calculation", + "enum": [ + "RUNNING", + "SYNCING", + "COMPLETED", + "FAILED", + "CANCELLED", + "NOT_FOUND", + "DISABLED" + ], "type": "string" } }, "required": [ - "name", - "serviceId" + "status" ], "type": "object" }, - "SetCertificationRequest": { - "description": "Request to set or clear the certification of a workspace entity.", + "Range": { "properties": { - "id": { - "description": "ID of the entity.", - "example": "total-sales", - "type": "string" + "from": { + "$ref": "#/components/schemas/Value" }, - "message": { - "description": "Optional message associated with the certification.", - "nullable": true, - "type": "string" + "measure": { + "$ref": "#/components/schemas/LocalIdentifier" }, - "status": { - "description": "Certification status of the entity.", + "operator": { "enum": [ - "CERTIFIED" + "BETWEEN", + "NOT_BETWEEN" ], - "nullable": true, "type": "string" }, - "type": { - "description": "Type of the entity.", - "enum": [ - "metric", - "visualizationObject", - "analyticalDashboard" - ], - "type": "string" + "to": { + "$ref": "#/components/schemas/Value" } }, "required": [ - "id", - "type" + "from", + "measure", + "operator", + "to" ], "type": "object" }, - "Settings": { - "description": "Additional settings.", + "RangeCondition": { + "description": "Condition that checks if the metric value is within a given range.", "properties": { - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", - "type": "string" - }, - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", - "example": true, - "type": "boolean" - }, - "grandTotalsPosition": { - "description": "Grand totals position. Takes precedence over position specified in visualization.", - "enum": [ - "pinnedBottom", - "pinnedTop", - "bottom", - "top" - ], - "type": "string" - }, - "mergeHeaders": { - "description": "Merge equal headers in neighbouring cells. (XLSX)", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" - }, - "pdfPageSize": { - "deprecated": true, - "description": "Page size and orientation. (PDF)", - "example": "a4 landscape", - "type": "string" - }, - "pdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } + "range": { + "properties": { + "from": { + "example": 100, + "type": "number" + }, + "operator": { + "enum": [ + "BETWEEN", + "NOT_BETWEEN" ], - "selector": "th" + "example": "BETWEEN", + "type": "string" + }, + "to": { + "example": 999, + "type": "number" } - ], - "items": { - "$ref": "#/components/schemas/PdfTableStyle" }, - "type": "array" - }, - "pdfTopLeftContent": { - "deprecated": true, - "description": "Top left header content. (PDF)", - "example": "Good", - "type": "string" - }, - "pdfTopRightContent": { - "deprecated": true, - "description": "Top right header content. (PDF)", - "example": "Morning", - "type": "string" - }, - "showFilters": { - "deprecated": true, - "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", - "example": false, - "type": "boolean" + "required": [ + "from", + "operator", + "to" + ], + "type": "object" } }, + "required": [ + "range" + ], "type": "object" }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "RangeMeasureValueFilter": { + "description": "Filter the result by comparing specified metric to given range of values.", "properties": { - "measure": { + "rangeMeasureValueFilter": { "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", - "COUNT", - "AVG", - "MIN", - "MAX", - "MEDIAN", - "RUNSUM", - "APPROXIMATE_COUNT" - ], - "example": "SUM", - "type": "string" - }, - "computeRatio": { - "default": false, - "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", - "example": true, + "applyOnResult": { "type": "boolean" }, - "filters": { - "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "dimensionality": { + "description": "References to the attributes to be used when filtering.", "items": { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" + "$ref": "#/components/schemas/AfmIdentifier" }, "type": "array" }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "from": { + "example": 100, + "type": "number" + }, + "localIdentifier": { + "type": "string" + }, + "measure": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "operator": { + "enum": [ + "BETWEEN", + "NOT_BETWEEN" + ], + "example": "BETWEEN", + "type": "string" + }, + "to": { + "example": 999, + "type": "number" + }, + "treatNullValuesAs": { + "description": "A value that will be substituted for null values in the metric for the comparisons.", + "example": 0, + "type": "number" } }, "required": [ - "item" + "from", + "measure", + "operator", + "to" ], "type": "object" } }, "required": [ - "measure" + "rangeMeasureValueFilter" ], "type": "object" }, - "Skeleton": { + "RangeWrapper": { "properties": { - "content": { - "items": { - "type": "object" - }, - "type": "array" - }, - "href": { - "type": "string", - "xml": { - "attribute": true - } - } - }, - "type": "object", - "xml": { - "name": "skeleton", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } - }, - "SlidesExportRequest": { - "description": "Export request object describing the export properties and metadata for slides exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PDF", - "PPTX" - ], - "example": "PDF", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "templateId": { - "description": "Export template identifier.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "timezoneId": { - "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", - "example": "Asia/Kolkata", - "nullable": true, - "type": "string" - }, - "visualizationIds": { - "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true + "range": { + "$ref": "#/components/schemas/Range" } }, "required": [ - "fileName", - "format" + "range" ], "type": "object" }, - "SmartFunctionResponse": { + "RankingFilter": { + "description": "Filter the result on top/bottom N values according to given metric(s).", "properties": { - "links": { - "$ref": "#/components/schemas/ExecutionLinks" - } - }, - "required": [ - "links" - ], - "type": "object" - }, - "Smtp": { - "allOf": [ - { + "rankingFilter": { "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "applyOnResult": { + "type": "boolean" }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from.", - "type": "string" + "dimensionality": { + "description": "References to the attributes to be used when filtering.", + "items": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "type": "array" }, - "host": { - "description": "The SMTP server address.", + "localIdentifier": { "type": "string" }, - "password": { - "description": "The SMTP server password.", - "type": "string", - "writeOnly": true - }, - "port": { - "description": "The SMTP server port.", - "enum": [ - 25, - 465, - 587, - 2525 - ], - "format": "int32", - "type": "integer" + "measures": { + "description": "References to the metrics to be used when filtering.", + "items": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "type": "array" }, - "type": { - "description": "The destination type.", + "operator": { + "description": "The type of ranking to use, TOP or BOTTOM.", "enum": [ - "SMTP" + "TOP", + "BOTTOM" ], "type": "string" }, - "username": { - "description": "The SMTP server username.", - "type": "string" + "strictLimitOfRows": { + "description": "When true, filter returns requested number of rows at most. Default is false.", + "type": "boolean" + }, + "value": { + "description": "Number of top/bottom values to filter.", + "example": 5, + "format": "int32", + "type": "integer" } }, + "required": [ + "measures", + "operator", + "value" + ], "type": "object" } + }, + "required": [ + "rankingFilter" ], - "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", + "type": "object" + }, + "RawCustomLabel": { + "description": "Custom label object override.", "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from.", - "format": "email", + "title": { + "description": "Override value.", "type": "string" - }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from.", + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "RawCustomMetric": { + "description": "Custom metric object override.", + "properties": { + "title": { + "description": "Metric title override.", "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "RawCustomOverride": { + "description": "Custom cell value overrides (IDs will be replaced with specified values).", + "properties": { + "labels": { + "additionalProperties": { + "$ref": "#/components/schemas/RawCustomLabel" + }, + "description": "Map of CustomLabels with keys used as placeholders in export result.", + "type": "object" }, - "host": { - "description": "The SMTP server address.", + "metrics": { + "additionalProperties": { + "$ref": "#/components/schemas/RawCustomMetric" + }, + "description": "Map of CustomMetrics with keys used as placeholders in export result.", + "type": "object" + } + }, + "type": "object" + }, + "RawExportAutomationRequest": { + "description": "Export request object describing the export properties and overrides for raw exports.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/RawCustomOverride" + }, + "delimiter": { + "description": "Set column delimiter. (CSV)", + "maxLength": 1, + "minLength": 1, + "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", "type": "string" }, - "password": { - "description": "The SMTP server password.", - "type": "string", - "writeOnly": true + "execution": { + "$ref": "#/components/schemas/AFM" }, - "port": { - "description": "The SMTP server port.", - "enum": [ - 25, - 465, - 587, - 2525 - ], - "format": "int32", - "type": "integer" + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" }, - "type": { - "description": "The destination type.", + "fileName": { + "description": "Filename of downloaded file without extension.", + "example": "result", + "type": "string" + }, + "format": { + "description": "Requested resulting file type.", "enum": [ - "SMTP" + "ARROW_FILE", + "ARROW_STREAM", + "CSV" ], + "example": "CSV", "type": "string" }, - "username": { - "description": "The SMTP server username.", - "type": "string" + "metadata": { + "$ref": "#/components/schemas/JsonNode" } }, "required": [ - "type" + "execution", + "fileName", + "format" ], "type": "object" }, - "SortKey": { - "oneOf": [ - { - "$ref": "#/components/schemas/SortKeyAttribute" + "RawExportRequest": { + "description": "Export request object describing the export properties and overrides for raw exports.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/RawCustomOverride" }, - { - "$ref": "#/components/schemas/SortKeyValue" + "delimiter": { + "description": "Set column delimiter. (CSV)", + "maxLength": 1, + "minLength": 1, + "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", + "type": "string" }, - { - "$ref": "#/components/schemas/SortKeyTotal" + "execution": { + "$ref": "#/components/schemas/AFM" + }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "fileName": { + "description": "Filename of downloaded file without extension.", + "example": "result", + "type": "string" + }, + "format": { + "description": "Requested resulting file type.", + "enum": [ + "ARROW_FILE", + "ARROW_STREAM", + "CSV" + ], + "example": "CSV", + "type": "string" } + }, + "required": [ + "execution", + "fileName", + "format" ], "type": "object" }, - "SortKeyAttribute": { - "description": "Sorting rule for sorting by attribute value in current dimension.", + "ReadCsvFileManifestsRequest": { + "description": "Request to read the manifests of the specified CSV files.", "properties": { - "attribute": { - "properties": { - "attributeIdentifier": { - "description": "Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed.", - "example": "attribute1", - "type": "string" - }, - "direction": { - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "sortType": { - "default": "DEFAULT", - "description": "Mechanism by which this attribute should be sorted. Available options are:\n- DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) \n- LABEL: sorting by this label values \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.", - "enum": [ - "DEFAULT", - "LABEL", - "ATTRIBUTE", - "AREA" - ], - "type": "string" - } + "manifestRequests": { + "description": "Files to read the manifests for.", + "items": { + "$ref": "#/components/schemas/ReadCsvFileManifestsRequestItem" }, - "required": [ - "attributeIdentifier" - ], - "type": "object" + "type": "array" } }, "required": [ - "attribute" + "manifestRequests" ], "type": "object" }, - "SortKeyTotal": { - "description": "Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total.", + "ReadCsvFileManifestsRequestItem": { + "description": "Request to read the manifest of a single CSV file.", "properties": { - "total": { - "properties": { - "dataColumnLocators": { - "$ref": "#/components/schemas/DataColumnLocators" - }, - "direction": { - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - }, - "totalIdentifier": { - "description": "Local identifier of the total to sort by.", - "type": "string" - } - }, - "required": [ - "totalIdentifier" - ], - "type": "object" + "fileName": { + "description": "Name of the CSV file to read the manifest for.", + "type": "string" + }, + "version": { + "description": "Optional version of the file to read the manifest for. If null or not specified, the latest version is read.", + "format": "int32", + "type": "integer" } }, "required": [ - "total" + "fileName" ], "type": "object" }, - "SortKeyValue": { - "description": "Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.", + "ReadCsvFileManifestsResponse": { + "description": "Describes the results of a CSV manifest read of a single file.", "properties": { - "value": { - "properties": { - "dataColumnLocators": { - "$ref": "#/components/schemas/DataColumnLocators" - }, - "direction": { - "description": "Sorting elements - ascending/descending order.", - "enum": [ - "ASC", - "DESC" - ], - "type": "string" - } - }, - "required": [ - "dataColumnLocators" - ], - "type": "object" + "manifest": { + "$ref": "#/components/schemas/CsvManifestBody" + }, + "name": { + "description": "Name of the file in the source data source.", + "type": "string" + }, + "version": { + "description": "Version of the file in the source data source.", + "format": "int32", + "type": "integer" } }, "required": [ - "value" + "manifest", + "name", + "version" ], "type": "object" }, - "SourceReferenceIdentifier": { - "description": "A source reference identifier.", + "ReferenceIdentifier": { + "description": "A reference identifier.", "properties": { "id": { - "description": "Source reference ID.", - "example": "fact_id", + "description": "Reference ID.", + "example": "customers", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type of the reference.", "enum": [ - "fact", - "attribute" + "dataset" ], - "example": "fact", + "example": "DATASET", "type": "string" } }, @@ -36842,11 +40864,12 @@ ], "type": "object" }, - "SqlColumn": { - "description": "A SQL query result column.", + "ReferenceSourceColumn": { "properties": { + "column": { + "type": "string" + }, "dataType": { - "description": "Column type", "enum": [ "INT", "STRING", @@ -36857,226 +40880,286 @@ "BOOLEAN", "HLL" ], - "example": "INT", - "type": "string" - }, - "description": { - "description": "Column description/comment from database", - "example": "Customer unique identifier", "type": "string" }, - "name": { - "description": "Column name", - "example": "customer_id", - "type": "string" + "isNullable": { + "type": "boolean" }, "nullValue": { - "description": "Value used as sentinel for null values in the column", - "example": "_", "type": "string" + }, + "target": { + "$ref": "#/components/schemas/DatasetGrain" } }, "required": [ - "dataType", - "name" + "target" ], "type": "object" }, - "SqlQuery": { - "allOf": [ - { - "$ref": "#/components/schemas/ColumnLocation" + "Relative": { + "properties": { + "measure": { + "$ref": "#/components/schemas/ArithmeticMeasure" }, - { - "properties": { - "sql": { - "type": "string" - } - }, - "type": "object" - } - ], - "required": [ - "sql" - ], - "type": "object" - }, - "StaticFeatures": { - "allOf": [ - { - "$ref": "#/components/schemas/Features" + "operator": { + "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", + "enum": [ + "INCREASES_BY", + "DECREASES_BY", + "CHANGES_BY" + ], + "type": "string" }, - { - "properties": { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - }, - "type": "object" + "threshold": { + "$ref": "#/components/schemas/Value" } - ], - "description": "Structure for offline feature flag", + }, "required": [ - "context", - "items" + "measure", + "operator", + "threshold" ], "type": "object" }, - "StringConstraints": { + "RelativeBoundedDateFilter": { "properties": { - "allowedValues": { - "items": { - "$ref": "#/components/schemas/StringParameterAllowedValue" - }, - "type": "array", - "uniqueItems": true - }, - "maxLength": { - "format": "int32", - "type": "integer" - }, - "minLength": { + "from": { "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "StringParameterAllowedValue": { - "properties": { - "title": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "value" - ], - "type": "object" - }, - "StringParameterDefinition": { - "properties": { - "constraints": { - "$ref": "#/components/schemas/StringConstraints" - }, - "defaultValue": { - "type": "string" }, - "type": { - "description": "The parameter type.", + "granularity": { "enum": [ - "STRING" + "ALL_TIME_GRANULARITY", + "GDC.time.year", + "GDC.time.week_us", + "GDC.time.week_in_year", + "GDC.time.week_in_quarter", + "GDC.time.week", + "GDC.time.euweek_in_year", + "GDC.time.euweek_in_quarter", + "GDC.time.quarter", + "GDC.time.quarter_in_year", + "GDC.time.month", + "GDC.time.month_in_quarter", + "GDC.time.month_in_year", + "GDC.time.day_in_year", + "GDC.time.day_in_quarter", + "GDC.time.day_in_month", + "GDC.time.day_in_week", + "GDC.time.day_in_euweek", + "GDC.time.date", + "GDC.time.hour", + "GDC.time.hour_in_day", + "GDC.time.minute", + "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", + "GDC.time.fiscal_month", + "GDC.time.fiscal_quarter", + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" ], "type": "string" + }, + "to": { + "format": "int32", + "type": "integer" } }, "required": [ - "defaultValue", - "type" + "granularity" ], "type": "object" }, - "SucceededOperation": { - "allOf": [ - { - "$ref": "#/components/schemas/Operation" - }, - { + "RelativeDateFilter": { + "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "properties": { + "relativeDateFilter": { "properties": { - "result": { - "description": "Operation-specific result payload, can be missing for operations like delete", - "type": "object" + "applyOnResult": { + "type": "boolean" + }, + "boundedFilter": { + "$ref": "#/components/schemas/BoundedFilter" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "from": { + "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", + "example": -6, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Date granularity specifying particular date attribute in given dimension.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "DAY", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", + "example": 0, + "format": "int32", + "type": "integer" } }, - "type": "object" - } - ], - "description": "Operation that has succeeded", - "properties": { - "status": { - "enum": [ - "succeeded" + "required": [ + "dataset", + "from", + "granularity", + "to" ], - "type": "string" + "type": "object" } }, "required": [ - "id", - "kind", - "status" + "relativeDateFilter" ], "type": "object" }, - "Suggestion": { - "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", + "RelativeWrapper": { "properties": { - "label": { - "description": "Suggestion button label", - "type": "string" - }, - "query": { - "description": "Suggestion query", - "type": "string" + "relative": { + "$ref": "#/components/schemas/Relative" } }, "required": [ - "label", - "query" + "relative" ], "type": "object" }, - "SwitchIdentityProviderRequest": { + "RemoveDatabaseDataSourceResponse": { + "description": "Confirmation of data source removal from an AI Lake Database instance", "properties": { - "idpId": { - "description": "Identity provider ID to set as active for the organization.", - "example": "my-idp-123", + "dataSourceId": { + "description": "Identifier of the removed data source in metadata-api.", "type": "string" } }, "required": [ - "idpId" + "dataSourceId" ], "type": "object" }, - "Table": { - "allOf": [ - { - "$ref": "#/components/schemas/ColumnLocation" + "ReportExportRequest": { + "description": "Export request object describing the export properties and metadata for report exports.", + "properties": { + "fileName": { + "description": "File name to be used for retrieving the pdf document.", + "example": "filename", + "type": "string" }, - { - "properties": { - "tableName": { - "type": "string" - } - }, - "type": "object" + "format": { + "description": "Requested resulting file type.", + "enum": [ + "PDF" + ], + "example": "PDF", + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/JsonNode" + }, + "reportId": { + "description": "Report identifier", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" } - ], + }, "required": [ - "tableName" + "fileName", + "format", + "reportId" ], "type": "object" }, - "TableOverride": { - "description": "Table override settings.", + "ResolveSettingsRequest": { + "description": "A request containing setting IDs to resolve.", "properties": { - "columns": { - "description": "An array of column overrides", - "items": { - "$ref": "#/components/schemas/ColumnOverride" - }, - "type": "array" - }, - "path": { - "description": "Path for the table.", + "settings": { + "description": "An array of setting IDs to resolve.", "example": [ - "schema", - "table_name" + "timezone" ], "items": { "type": "string" @@ -37085,902 +41168,867 @@ } }, "required": [ - "columns", - "path" + "settings" ], "type": "object" }, - "TableStatisticsEntry": { + "ResolvedSetting": { + "description": "Setting and its value.", "properties": { - "columns": { - "items": { - "$ref": "#/components/schemas/ColumnStatisticsEntry" - }, - "type": "array" - }, - "dataSize": { - "description": "Total data size of the table in bytes.", - "format": "int64", - "type": "integer" - }, - "rowCount": { - "description": "Total number of rows in the table.", - "format": "int64", - "type": "integer" + "content": { + "$ref": "#/components/schemas/JsonNode" }, - "schemaName": { + "id": { + "deprecated": true, + "description": "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", "type": "string" }, - "tableName": { + "type": { + "description": "Type of the setting.", + "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", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "example": "TIMEZONE", "type": "string" } }, "required": [ - "columns", - "schemaName", - "tableName" + "id" ], "type": "object" }, - "TableStatisticsRequest": { + "RestApiIdentifier": { + "description": "Object identifier.", "properties": { - "schemata": { - "items": { - "type": "string" - }, - "type": "array" + "id": { + "example": "sample_item.price", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" }, - "tableNames": { - "items": { - "type": "string" - }, - "type": "array" + "type": { + "example": "fact", + "type": "string" } }, "required": [ - "schemata" + "id", + "type" ], "type": "object" }, - "TableStatisticsResponse": { + "RestrictedObject": { + "description": "A reference the caller may not view.", "properties": { - "tables": { - "items": { - "$ref": "#/components/schemas/TableStatisticsEntry" - }, - "type": "array" + "id": { + "description": "Object identifier, unique within one workspace hierarchy.", + "type": "string" }, - "warnings": { - "items": { - "$ref": "#/components/schemas/TableStatisticsWarning" - }, - "type": "array" + "type": { + "description": "JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.", + "enum": [ + "analyticalDashboard", + "attribute", + "attributeHierarchy", + "computedAttribute", + "fact", + "label", + "metric", + "userDataFilter", + "visualizationObject" + ], + "type": "string" } }, "required": [ - "tables", - "warnings" + "id", + "type" ], "type": "object" }, - "TableStatisticsWarning": { + "ResultCacheMetadata": { + "description": "All execution result's metadata used for calculation including ExecutionResponse", "properties": { - "message": { - "type": "string" + "afm": { + "$ref": "#/components/schemas/AFM" }, - "tableName": { - "type": "string" + "executionResponse": { + "$ref": "#/components/schemas/ExecutionResponse" + }, + "resultSize": { + "format": "int64", + "type": "integer" + }, + "resultSpec": { + "$ref": "#/components/schemas/ResultSpec" } }, "required": [ - "message" + "afm", + "executionResponse", + "resultSize", + "resultSpec" ], "type": "object" }, - "TableWarning": { - "description": "Warnings related to single table.", + "ResultDimension": { + "description": "Single result dimension", "properties": { - "columns": { + "headers": { "items": { - "$ref": "#/components/schemas/ColumnWarning" + "$ref": "#/components/schemas/ResultDimensionHeader" }, "type": "array" }, - "message": { - "description": "Warning message related to the table.", - "type": "string" - }, - "name": { - "description": "Table name.", + "localIdentifier": { + "description": "Local identifier of the dimension.", "type": "string" } }, "required": [ - "columns", - "name" + "headers", + "localIdentifier" ], "type": "object" }, - "TabularExportExecution": { - "description": "A single pre-executed layer in a multi-layer tabular export.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" + "ResultDimensionHeader": { + "description": "One of the headers in a result dimension.", + "oneOf": [ + { + "$ref": "#/components/schemas/MeasureGroupHeaders" }, - "executionResult": { - "description": "Execution result identifier for this layer.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", - "type": "string" + { + "$ref": "#/components/schemas/AttributeHeader" + } + ], + "type": "object" + }, + "ResultSpec": { + "description": "Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).", + "properties": { + "dimensions": { + "items": { + "$ref": "#/components/schemas/Dimension" + }, + "type": "array" }, - "title": { - "description": "Layer title used for the exported sheet or file name.", - "example": "Pushpins", - "type": "string" + "totals": { + "items": { + "$ref": "#/components/schemas/Total" + }, + "type": "array" } }, "required": [ - "executionResult" + "dimensions" ], "type": "object" }, - "TabularExportRequest": { - "description": "Export request object describing the export properties and overrides for tabular exports.", + "RsaSpecification": { "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" - }, - "executionResult": { - "description": "Execution result identifier.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "alg": { + "enum": [ + "RS256", + "RS384", + "RS512" + ], "type": "string" }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "executions": { - "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", - "items": { - "$ref": "#/components/schemas/TabularExportExecution" - }, - "type": "array" + "e": { + "type": "string" }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", + "kid": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[^.]", "type": "string" }, - "format": { - "description": "Expected file format.", + "kty": { "enum": [ - "CSV", - "XLSX", - "HTML", - "PDF" + "RSA" ], - "example": "CSV", "type": "string" }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "relatedDashboardId": { - "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "n": { "type": "string" }, - "settings": { - "$ref": "#/components/schemas/Settings" - }, - "visualizationObject": { - "description": "Visualization object identifier. Alternative to executionResult property.", - "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", + "use": { + "enum": [ + "sig" + ], "type": "string" }, - "visualizationObjectCustomFilters": { - "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", - "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", + "x5c": { "items": { - "type": "object" + "type": "string" }, "type": "array" }, - "visualizationObjectCustomParameters": { - "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", - "items": { - "$ref": "#/components/schemas/ParameterValue" - }, - "type": "array" + "x5t": { + "type": "string" } }, "required": [ - "fileName", - "format" + "alg", + "e", + "kid", + "kty", + "n", + "use" ], "type": "object" }, - "TelemetryConfig": { - "description": "Telemetry-related configuration.", + "RulePermission": { + "description": "List of rules", "properties": { - "context": { - "$ref": "#/components/schemas/TelemetryContext" + "permissions": { + "description": "Permissions granted by the rule", + "items": { + "$ref": "#/components/schemas/GrantedPermission" + }, + "type": "array" }, - "services": { - "$ref": "#/components/schemas/TelemetryServices" + "type": { + "description": "Type of the rule", + "example": "allWorkspaceUsers", + "type": "string" } }, "required": [ - "context", - "services" + "type" ], "type": "object" }, - "TelemetryContext": { - "description": "The telemetry context.", + "RunServiceCommandRequest": { + "description": "Request to run an AI Lake Service Command", "properties": { - "deploymentId": { - "description": "Identification of the deployment.", - "type": "string" - }, - "organizationHash": { - "description": "Organization hash.", - "type": "string" + "context": { + "additionalProperties": { + "description": "The context to pass to the command", + "nullable": true, + "type": "string" + }, + "description": "The context to pass to the command", + "nullable": true, + "type": "object" }, - "userHash": { - "description": "User hash.", - "type": "string" + "payload": { + "$ref": "#/components/schemas/JsonNode" } }, - "required": [ - "deploymentId", - "organizationHash", - "userHash" - ], "type": "object" }, - "TelemetryServices": { - "description": "Available telemetry services.", + "RunningSection": { + "description": "Footer section of the slide", + "nullable": true, "properties": { - "amplitude": { - "$ref": "#/components/schemas/AmplitudeService" - }, - "matomo": { - "$ref": "#/components/schemas/MatomoService" + "left": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" }, - "openTelemetry": { - "$ref": "#/components/schemas/OpenTelemetryService" + "right": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" } }, "type": "object" }, - "TestDefinitionRequest": { - "description": "A request containing all information for testing data source definition.", + "ScanRequest": { + "description": "A request containing all information critical to model scanning.", "properties": { - "authenticationType": { - "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", - "enum": [ - "USERNAME_PASSWORD", - "TOKEN", - "KEY_PAIR", - "CLIENT_SECRET", - "OIDC_PASSTHROUGH" - ], - "nullable": true, - "type": "string" - }, - "clientId": { - "description": "Id for client based authentication for data sources which supports it.", - "type": "string" + "scanTables": { + "description": "A flag indicating whether the tables should be scanned.", + "example": true, + "type": "boolean" }, - "clientSecret": { - "description": "Secret for client based authentication for data sources which supports it.", - "type": "string" + "scanViews": { + "description": "A flag indicating whether the views should be scanned.", + "example": true, + "type": "boolean" }, - "parameters": { + "schemata": { + "description": "What schemata will be scanned.", + "example": [ + "tpch", + "demo" + ], "items": { - "$ref": "#/components/schemas/DataSourceParameter" + "type": "string" }, "type": "array" }, - "password": { - "description": "Database user password.", - "example": "admin123", - "type": "string" - }, - "privateKey": { - "description": "Private key for data sources which supports key-pair authentication.", - "type": "string" - }, - "privateKeyPassphrase": { - "description": "Passphrase for a encrypted version of a private key.", - "type": "string" - }, - "schema": { - "description": "Database schema.", - "example": "public", - "type": "string" - }, - "token": { - "description": "Secret for token based authentication for data sources which supports it.", - "type": "string" - }, - "type": { - "description": "Type of database, where test should connect to.", - "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" - ], - "example": "POSTGRESQL", + "separator": { + "description": "A separator between prefixes and the names.", + "example": "__", "type": "string" }, - "url": { - "description": "URL to database in JDBC format, where test should connect to.", - "example": "jdbc:postgresql://localhost:5432/db_name", + "tablePrefix": { + "description": "Tables starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the table prefix is `out_table` and separator is `__`, the table with name like `out_table__customers` will be scanned.", + "example": "out_table", "type": "string" }, - "username": { - "description": "Database user name.", - "example": "dbadmin", + "viewPrefix": { + "description": "Views starting with this prefix will be scanned. The prefix is then followed by the value of `separator` parameter. Given the view prefix is `out_view` and separator is `__`, the table with name like `out_view__us_customers` will be scanned.", + "example": "out_view", "type": "string" } }, "required": [ - "type" + "scanTables", + "scanViews", + "separator" ], "type": "object" }, - "TestDestinationRequest": { - "description": "Request body with notification channel destination to test.", + "ScanResultPdm": { + "description": "Result of scan of data source physical model.", "properties": { - "destination": { - "$ref": "#/components/schemas/NotificationChannelDestination" + "pdm": { + "$ref": "#/components/schemas/DeclarativeTables" }, - "externalRecipients": { - "description": "External recipients of the test result.", + "warnings": { "items": { - "$ref": "#/components/schemas/AutomationExternalRecipient" + "$ref": "#/components/schemas/TableWarning" }, - "maxItems": 1, - "nullable": true, - "type": "array", - "uniqueItems": true + "type": "array" } }, "required": [ - "destination" + "pdm", + "warnings" ], "type": "object" }, - "TestLlmProviderByIdRequest": { + "ScanSqlRequest": { + "description": "A request with SQL query to by analyzed.", "properties": { - "models": { - "description": "Models overrides.", - "items": { - "$ref": "#/components/schemas/LlmModel" - }, - "type": "array" - }, - "providerConfig": { - "$ref": "#/components/schemas/LlmProviderConfig" + "sql": { + "description": "SQL query to be analyzed.", + "example": "SELECT a.special_value as result FROM tableA a", + "type": "string" } }, + "required": [ + "sql" + ], "type": "object" }, - "TestLlmProviderDefinitionRequest": { + "ScanSqlResponse": { + "description": "Result of scanSql. Consists of array of query columns including type. Sql query result data preview can be attached optionally", "properties": { - "models": { - "description": "Models to test.", + "columns": { + "description": "Array of columns with types.", "items": { - "$ref": "#/components/schemas/LlmModel" + "$ref": "#/components/schemas/SqlColumn" }, "type": "array" }, - "providerConfig": { - "$ref": "#/components/schemas/LlmProviderConfig" - } - }, - "required": [ - "providerConfig" - ], - "type": "object" - }, - "TestLlmProviderResponse": { - "properties": { - "modelResults": { - "description": "Per-model test results.", + "dataPreview": { + "description": "Array of rows where each row is another array of string values.", "items": { - "$ref": "#/components/schemas/ModelTestResult" + "items": { + "nullable": true, + "type": "string" + }, + "type": "array" }, "type": "array" - }, - "providerMessage": { - "description": "Message about the provider connectivity test.", - "type": "string" - }, - "providerReachable": { - "description": "Whether the LLM provider is reachable.", - "type": "boolean" } }, "required": [ - "modelResults", - "providerMessage", - "providerReachable" + "columns" ], "type": "object" }, - "TestNotification": { - "allOf": [ - { - "$ref": "#/components/schemas/NotificationContent" - }, - { - "properties": { - "message": { - "type": "string" - } - }, - "type": "object" - } - ], + "ScheduleCacheRetention": { + "description": "The cache expires according to a schedule.", "properties": { + "schedule": { + "$ref": "#/components/schemas/CacheRetentionSchedule" + }, "type": { + "description": "The cache retention type.", "enum": [ - "TEST" + "SCHEDULE" ], "type": "string" } }, "required": [ - "message", + "schedule", "type" ], "type": "object" }, - "TestQueryDuration": { - "description": "A structure containing duration of the test queries run on a data source. It is omitted if an error happens.", - "properties": { - "createCacheTable": { - "description": "Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching.", - "example": 235, - "format": "int32", - "type": "integer" - }, - "simpleSelect": { - "description": "Field containing duration of a test select query on a data source. In milliseconds.", - "example": 562, - "format": "int32", - "type": "integer" - } - }, - "required": [ - "simpleSelect" - ], - "type": "object" - }, - "TestRequest": { - "description": "A request containing all information for testing existing data source.", + "SectionSlideTemplate": { + "description": "Settings for section slide.", + "nullable": true, "properties": { - "authenticationType": { - "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", - "enum": [ - "USERNAME_PASSWORD", - "TOKEN", - "KEY_PAIR", - "CLIENT_SECRET", - "OIDC_PASSTHROUGH" - ], - "nullable": true, - "type": "string" - }, - "clientId": { - "description": "Id for client based authentication for data sources which supports it.", - "type": "string" - }, - "clientSecret": { - "description": "Secret for client based authentication for data sources which supports it.", - "type": "string" - }, - "parameters": { - "items": { - "$ref": "#/components/schemas/DataSourceParameter" - }, - "type": "array" - }, - "password": { - "description": "Database user password.", - "example": "admin123", - "type": "string" - }, - "privateKey": { - "description": "Private key for data sources which supports key-pair authentication.", - "type": "string" - }, - "privateKeyPassphrase": { - "description": "Passphrase for a encrypted version of a private key.", - "type": "string" - }, - "schema": { - "description": "Database schema.", - "example": "public", - "type": "string" - }, - "token": { - "description": "Secret for token based authentication for data sources which supports it.", - "type": "string" + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" }, - "url": { - "description": "URL to database in JDBC format, where test should connect to.", - "example": "jdbc:postgresql://localhost:5432/db_name", - "type": "string" + "footer": { + "$ref": "#/components/schemas/RunningSection" }, - "username": { - "description": "Database user name.", - "example": "dbadmin", - "type": "string" + "header": { + "$ref": "#/components/schemas/RunningSection" } }, "type": "object" }, - "TestResponse": { - "description": "Response from data source testing.", + "ServiceInfo": { + "description": "Non-sensitive metadata for an AI Lake pipeline", "properties": { - "error": { - "description": "Field containing more details in case of a failure. Details are available to a privileged user only.", - "example": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", + "name": { + "description": "Human-readable name of the service", "type": "string" }, - "queryDurationMillis": { - "$ref": "#/components/schemas/TestQueryDuration" - }, - "successful": { - "description": "A flag indicating whether test passed or not.", - "example": true, - "type": "boolean" - } - }, - "required": [ - "successful" - ], - "type": "object" - }, - "Thought": { - "description": "Detailed thoughts/messages within this step.", - "properties": { - "text": { - "description": "The text content of this thought.", + "serviceId": { + "description": "Internal identifier for the service configuration (UUID)", "type": "string" } }, "required": [ - "text" + "name", + "serviceId" ], "type": "object" }, - "TimeSlicePartitionConfig": { - "description": "Partition by time_slice() expression.", + "SetCertificationRequest": { + "description": "Request to set or clear the certification of a workspace entity.", "properties": { - "column": { - "description": "Column to partition on.", + "id": { + "description": "ID of the entity.", + "example": "total-sales", "type": "string" }, - "slices": { - "description": "How many units per slice.", - "format": "int32", - "minimum": 1, - "type": "integer" + "message": { + "description": "Optional message associated with the certification.", + "nullable": true, + "type": "string" }, - "type": { + "status": { + "description": "Certification status of the entity.", "enum": [ - "timeSlice" + "CERTIFIED" ], + "nullable": true, "type": "string" }, - "unit": { - "description": "Date/time unit for partition granularity", + "type": { + "description": "Type of the entity.", "enum": [ - "year", - "quarter", - "month", - "week", - "day", - "hour", - "minute", - "second", - "millisecond", - "microsecond" + "metric", + "visualizationObject", + "analyticalDashboard", + "computedAttribute" ], "type": "string" } }, "required": [ - "column", - "slices", - "type", - "unit" + "id", + "type" ], "type": "object" }, - "Total": { - "description": "Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension`", + "Settings": { + "description": "Additional settings.", "properties": { - "function": { - "description": "Aggregation function to compute the total.", + "delimiter": { + "description": "Set column delimiter. (CSV)", + "maxLength": 1, + "minLength": 1, + "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", + "type": "string" + }, + "exportInfo": { + "default": false, + "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", + "example": true, + "type": "boolean" + }, + "grandTotalsPosition": { + "description": "Grand totals position. Takes precedence over position specified in visualization.", "enum": [ - "SUM", - "MIN", - "MAX", - "AVG", - "MED", - "NAT" + "pinnedBottom", + "pinnedTop", + "bottom", + "top" ], - "example": "SUM", "type": "string" }, - "localIdentifier": { - "description": "Total identification within this request. Used e.g. in sorting by a total.", - "example": "firstTotal", + "mergeHeaders": { + "description": "Merge equal headers in neighbouring cells. (XLSX)", + "example": true, + "type": "boolean" + }, + "pageOrientation": { + "default": "PORTRAIT", + "description": "Set page orientation. (PDF)", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], "type": "string" }, - "metric": { - "description": "The metric for which the total will be computed", - "example": "metric_1", + "pageSize": { + "default": "A4", + "description": "Set page size. (PDF)", + "enum": [ + "A3", + "A4", + "LETTER" + ], "type": "string" }, - "totalDimensions": { - "items": { - "$ref": "#/components/schemas/TotalDimension" - }, - "type": "array" - } - }, - "required": [ - "function", - "localIdentifier", - "metric", - "totalDimensions" - ], - "type": "object" - }, - "TotalDimension": { - "description": "A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.", - "properties": { - "dimensionIdentifier": { - "description": "An identifier of a dimension for which the total will be computed.", - "example": "firstDimension", - "pattern": "^[.a-zA-Z0-9_-]+$", + "pdfPageSize": { + "deprecated": true, + "description": "Page size and orientation. (PDF)", + "example": "a4 landscape", "type": "string" }, - "totalDimensionItems": { - "description": "List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.", + "pdfTableStyle": { + "deprecated": true, + "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ - "measureGroup" + { + "properties": [ + { + "key": "font-size", + "value": "30px" + } + ], + "selector": "th" + } ], "items": { - "type": "string" + "$ref": "#/components/schemas/PdfTableStyle" }, "type": "array" + }, + "pdfTopLeftContent": { + "deprecated": true, + "description": "Top left header content. (PDF)", + "example": "Good", + "type": "string" + }, + "pdfTopRightContent": { + "deprecated": true, + "description": "Top right header content. (PDF)", + "example": "Morning", + "type": "string" + }, + "showFilters": { + "deprecated": true, + "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", + "example": false, + "type": "boolean" } }, - "required": [ - "dimensionIdentifier", - "totalDimensionItems" - ], "type": "object" }, - "TotalExecutionResultHeader": { + "SimpleMeasureDefinition": { + "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", "properties": { - "totalHeader": { - "$ref": "#/components/schemas/TotalResultHeader" + "measure": { + "properties": { + "aggregation": { + "description": "Definition of aggregation type of the metric.", + "enum": [ + "SUM", + "COUNT", + "AVG", + "MIN", + "MAX", + "MEDIAN", + "RUNSUM", + "APPROXIMATE_COUNT" + ], + "example": "SUM", + "type": "string" + }, + "computeRatio": { + "default": false, + "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", + "example": true, + "type": "boolean" + }, + "filters": { + "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "items": { + "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, + "type": "array" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "item" + ], + "type": "object" } }, "required": [ - "totalHeader" + "measure" ], "type": "object" }, - "TotalResultHeader": { - "description": "Header containing the information related to a subtotal.", + "Skeleton": { "properties": { - "function": { - "type": "string" + "content": { + "items": { + "type": "object" + }, + "type": "array" + }, + "href": { + "type": "string", + "xml": { + "attribute": true + } } }, - "required": [ - "function" - ], - "type": "object" + "type": "object", + "xml": { + "name": "skeleton", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } }, - "TrendingObjectItem": { - "description": "Trending analytics catalog objects", + "SlidesExportRequest": { + "description": "Export request object describing the export properties and metadata for slides exports.", "properties": { - "createdAt": { - "description": "Timestamp when object was created.", - "format": "date-time", - "type": "string" - }, - "createdBy": { - "description": "ID of the user who created the object.", - "type": "string" - }, - "datasetId": { - "description": "ID of the associated dataset, if applicable.", - "type": "string" - }, - "datasetTitle": { - "description": "Title of the associated dataset, if applicable.", - "type": "string" - }, - "datasetType": { - "description": "Type of the associated dataset, if applicable.", + "dashboardId": { + "description": "Dashboard identifier", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, - "description": { - "description": "Object description.", + "fileName": { + "description": "File name to be used for retrieving the pdf document.", + "example": "filename", "type": "string" }, - "id": { - "description": "Object ID.", + "format": { + "description": "Requested resulting file type.", + "enum": [ + "PDF", + "PPTX" + ], + "example": "PDF", "type": "string" }, - "isHidden": { - "description": "If true, this object is hidden from AI search results by default.", - "type": "boolean" - }, - "isHiddenFromKda": { - "description": "If true, this object is hidden from KDA.", - "type": "boolean" - }, - "metricType": { - "description": "Type of the metric (e.g. MAQL), if applicable.", - "type": "string" + "metadata": { + "$ref": "#/components/schemas/JsonNode" }, - "modifiedAt": { - "description": "Timestamp when object was last modified.", - "format": "date-time", + "templateId": { + "description": "Export template identifier.", + "maxLength": 255, + "nullable": true, "type": "string" }, - "modifiedBy": { - "description": "ID of the user who last modified the object.", + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, "type": "string" }, - "tags": { + "visualizationIds": { + "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", "items": { - "description": "Tags assigned to the object.", + "maxLength": 255, + "minLength": 1, "type": "string" }, - "type": "array" - }, - "title": { - "description": "Object title.", - "type": "string" - }, - "type": { - "description": "Object type, e.g. dashboard, visualization, metric.", - "type": "string" - }, - "usageCount": { - "description": "Number of times this object has been used/referenced.", - "format": "int32", - "type": "integer" - }, - "visualizationUrl": { - "description": "URL of the visualization, if applicable.", - "type": "string" + "maxItems": 1, + "type": "array", + "uniqueItems": true }, - "workspaceId": { - "description": "Workspace ID the object belongs to.", - "type": "string" - } - }, - "required": [ - "id", - "tags", - "title", - "type", - "usageCount", - "workspaceId" - ], - "type": "object" - }, - "TrendingObjectsResult": { - "properties": { - "objects": { + "widgetIds": { + "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { - "$ref": "#/components/schemas/TrendingObjectItem" + "maxLength": 255, + "minLength": 1, + "type": "string" }, - "type": "array" + "maxItems": 1, + "type": "array", + "uniqueItems": true } }, "required": [ - "objects" + "fileName", + "format" ], "type": "object" }, - "TriggerAutomationRequest": { + "SmartFunctionResponse": { "properties": { - "automation": { - "$ref": "#/components/schemas/AdHocAutomation" + "links": { + "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ - "automation" + "links" ], "type": "object" }, - "TriggerQualityIssuesCalculationResponse": { + "Smtp": { + "allOf": [ + { + "properties": { + "fromEmail": { + "default": "no-reply@gooddata.com", + "description": "E-mail address to send notifications from.", + "format": "email", + "type": "string" + }, + "fromEmailName": { + "default": "GoodData", + "description": "An optional e-mail name to send notifications from.", + "type": "string" + }, + "host": { + "description": "The SMTP server address.", + "type": "string" + }, + "password": { + "description": "The SMTP server password.", + "type": "string", + "writeOnly": true + }, + "port": { + "description": "The SMTP server port.", + "enum": [ + 25, + 465, + 587, + 2525 + ], + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The destination type.", + "enum": [ + "SMTP" + ], + "type": "string" + }, + "username": { + "description": "The SMTP server username.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", "properties": { - "processId": { - "description": "Process ID for tracking the calculation status", + "fromEmail": { + "default": "no-reply@gooddata.com", + "description": "E-mail address to send notifications from.", + "format": "email", "type": "string" }, - "status": { - "description": "Current status of the calculation", + "fromEmailName": { + "default": "GoodData", + "description": "An optional e-mail name to send notifications from.", + "type": "string" + }, + "host": { + "description": "The SMTP server address.", + "type": "string" + }, + "password": { + "description": "The SMTP server password.", + "type": "string", + "writeOnly": true + }, + "port": { + "description": "The SMTP server port.", "enum": [ - "RUNNING", - "COMPLETED", - "FAILED", - "CANCELLED", - "DISABLED" + 25, + 465, + 587, + 2525 ], - "type": "string" - } - }, - "required": [ - "processId", - "status" - ], - "type": "object" - }, - "UIContext": { - "description": "Ambient UI state: what the user is currently looking at (dashboard, visible widgets).", - "properties": { - "dashboard": { - "$ref": "#/components/schemas/DashboardContext" - } - }, - "type": "object" - }, - "UniqueKeyConfig": { - "description": "Unique key model — enforces uniqueness, replaces on conflict.", - "properties": { - "columns": { - "description": "Key columns. Defaults to first inferred column.", - "items": { - "description": "Key columns. Defaults to first inferred column.", - "type": "string" - }, - "type": "array" + "format": "int32", + "type": "integer" }, "type": { + "description": "The destination type.", "enum": [ - "unique" + "SMTP" ], "type": "string" + }, + "username": { + "description": "The SMTP server username.", + "type": "string" } }, "required": [ @@ -37988,1277 +42036,1356 @@ ], "type": "object" }, - "UpdateDatabaseDataSourceRequest": { - "description": "Request to update the data source associated with an AI Lake Database instance", - "properties": { - "dataSourceId": { - "description": "New identifier for the data source in metadata-api. Must be unique within the organization.", - "type": "string" + "SortKey": { + "oneOf": [ + { + "$ref": "#/components/schemas/SortKeyAttribute" }, - "dataSourceName": { - "description": "New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.", - "type": "string" + { + "$ref": "#/components/schemas/SortKeyValue" }, - "oldDataSourceId": { - "description": "Identifier of the existing data source to replace.", - "type": "string" + { + "$ref": "#/components/schemas/SortKeyTotal" } - }, - "required": [ - "dataSourceId", - "oldDataSourceId" ], "type": "object" }, - "UpdateDatabaseDataSourceResponse": { - "description": "Updated data source details for an AI Lake Database instance", + "SortKeyAttribute": { + "description": "Sorting rule for sorting by attribute value in current dimension.", "properties": { - "dataSourceId": { - "description": "New identifier of the data source in metadata-api.", - "type": "string" - }, - "dataSourceName": { - "description": "New display name of the data source in metadata-api.", - "type": "string" + "attribute": { + "properties": { + "attributeIdentifier": { + "description": "Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed.", + "example": "attribute1", + "type": "string" + }, + "direction": { + "description": "Sorting elements - ascending/descending order.", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "sortType": { + "default": "DEFAULT", + "description": "Mechanism by which this attribute should be sorted. Available options are:\n- DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) \n- LABEL: sorting by this label values \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.", + "enum": [ + "DEFAULT", + "LABEL", + "ATTRIBUTE", + "AREA" + ], + "type": "string" + } + }, + "required": [ + "attributeIdentifier" + ], + "type": "object" } }, "required": [ - "dataSourceId", - "dataSourceName" + "attribute" ], "type": "object" }, - "UploadFileResponse": { - "description": "Information related to the file uploaded to the staging area.", + "SortKeyTotal": { + "description": "Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total.", "properties": { - "location": { - "description": "Location to use when referencing the uploaded file in subsequent requests.", - "type": "string" - } - }, + "total": { + "properties": { + "dataColumnLocators": { + "$ref": "#/components/schemas/DataColumnLocators" + }, + "direction": { + "description": "Sorting elements - ascending/descending order.", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + }, + "totalIdentifier": { + "description": "Local identifier of the total to sort by.", + "type": "string" + } + }, + "required": [ + "totalIdentifier" + ], + "type": "object" + } + }, "required": [ - "location" + "total" ], "type": "object" }, - "UploadGeoCollectionFileResponse": { - "description": "Information related to the geo collection file uploaded to the staging area.", + "SortKeyValue": { + "description": "Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.", "properties": { - "location": { - "description": "Location to use when referencing the uploaded file in subsequent requests.", + "value": { + "properties": { + "dataColumnLocators": { + "$ref": "#/components/schemas/DataColumnLocators" + }, + "direction": { + "description": "Sorting elements - ascending/descending order.", + "enum": [ + "ASC", + "DESC" + ], + "type": "string" + } + }, + "required": [ + "dataColumnLocators" + ], + "type": "object" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "SourceReferenceIdentifier": { + "description": "A source reference identifier.", + "properties": { + "id": { + "description": "Source reference ID.", + "example": "fact_id", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "A type of the reference.", + "enum": [ + "fact", + "attribute" + ], + "example": "fact", "type": "string" } }, "required": [ - "location" + "id", + "type" ], "type": "object" }, - "UserAssignee": { - "description": "List of users", + "SqlColumn": { + "description": "A SQL query result column.", "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", + "dataType": { + "description": "Column type", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "example": "INT", "type": "string" }, - "id": { + "description": { + "description": "Column description/comment from database", + "example": "Customer unique identifier", "type": "string" }, "name": { - "description": "User name", - "example": "John Wick", + "description": "Column name", + "example": "customer_id", + "type": "string" + }, + "nullValue": { + "description": "Value used as sentinel for null values in the column", + "example": "_", "type": "string" } }, "required": [ - "id" + "dataType", + "name" ], "type": "object" }, - "UserContext": { - "description": "User context with ambient UI state (view) and explicitly referenced objects.", - "properties": { - "activeObject": { - "$ref": "#/components/schemas/ActiveObjectIdentification" + "SqlFlowInput": { + "allOf": [ + { + "properties": { + "dataSourceId": { + "description": "Identifier of the data source that runs the statement.", + "type": "string" + }, + "sql": { + "description": "One SELECT statement in the SQL dialect of the data source.", + "example": "SELECT region, SUM(amount) AS amount FROM sales GROUP BY region", + "type": "string" + }, + "type": { + "description": "Type of the input.", + "enum": [ + "sql" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Runs a SELECT statement on a data source and reads its rows as a table. Its columns are named and typed as the statement returns them. Data filters of the workspace and of the user do not apply. A GDSTORAGE, FlexConnect or platform-managed data source cannot run it.", + "required": [ + "dataSourceId", + "sql", + "type" + ], + "type": "object" + }, + "SqlQuery": { + "allOf": [ + { + "$ref": "#/components/schemas/ColumnLocation" + }, + { + "properties": { + "sql": { + "type": "string" + } + }, + "type": "object" + } + ], + "required": [ + "sql" + ], + "type": "object" + }, + "StaticFeatures": { + "allOf": [ + { + "$ref": "#/components/schemas/Features" }, - "referencedObjects": { - "description": "Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).", + { + "properties": { + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + } + ], + "description": "Structure for offline feature flag", + "required": [ + "context", + "items" + ], + "type": "object" + }, + "StringConstraints": { + "properties": { + "allowedValues": { "items": { - "$ref": "#/components/schemas/ObjectReferenceGroup" + "$ref": "#/components/schemas/StringParameterAllowedValue" }, - "type": "array" + "type": "array", + "uniqueItems": true + }, + "maxLength": { + "format": "int32", + "type": "integer" }, - "view": { - "$ref": "#/components/schemas/UIContext" + "minLength": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "UserGroupAssignee": { - "description": "List of user groups", + "StringParameterAllowedValue": { "properties": { - "id": { + "title": { "type": "string" }, - "name": { - "description": "User group name", - "example": "admins", + "value": { "type": "string" } }, "required": [ - "id" + "value" ], "type": "object" }, - "UserGroupIdentifier": { - "description": "A list of groups where user is a member", + "StringParameterDefinition": { "properties": { - "id": { + "constraints": { + "$ref": "#/components/schemas/StringConstraints" + }, + "defaultValue": { "type": "string" }, - "name": { + "type": { + "description": "The parameter type.", + "enum": [ + "STRING" + ], "type": "string" } }, "required": [ - "id" + "defaultValue", + "type" ], "type": "object" }, - "UserGroupPermission": { - "description": "List of user groups", - "properties": { - "id": { - "type": "string" - }, - "name": { - "description": "Name of the user group", - "example": "admins", - "type": "string" + "SucceededOperation": { + "allOf": [ + { + "$ref": "#/components/schemas/Operation" }, - "permissions": { - "description": "Permissions granted to the user group", - "items": { - "$ref": "#/components/schemas/GrantedPermission" + { + "properties": { + "result": { + "description": "Operation-specific result payload, can be missing for operations like delete", + "type": "object" + } }, - "type": "array" + "type": "object" + } + ], + "description": "Operation that has succeeded", + "properties": { + "status": { + "enum": [ + "succeeded" + ], + "type": "string" } }, "required": [ - "id" + "id", + "kind", + "status" ], "type": "object" }, - "UserManagementDataSourcePermissionAssignment": { - "description": "Datasource permission assignments for users and userGroups", + "SwitchIdentityProviderRequest": { "properties": { - "accessSource": { - "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", - "enum": [ - "DIRECT", - "GROUP" - ], - "readOnly": true, - "type": "string" - }, - "id": { - "description": "Id of the datasource", - "type": "string" - }, - "name": { - "description": "Name of the datasource", - "readOnly": true, + "idpId": { + "description": "Identity provider ID to set as active for the organization.", + "example": "my-idp-123", "type": "string" + } + }, + "required": [ + "idpId" + ], + "type": "object" + }, + "Table": { + "allOf": [ + { + "$ref": "#/components/schemas/ColumnLocation" }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "USE" - ], - "type": "string" + { + "properties": { + "tableName": { + "type": "string" + } }, - "type": "array" + "type": "object" } - }, + ], "required": [ - "id", - "permissions" + "tableName" ], "type": "object" }, - "UserManagementPermissionAssignments": { + "TableOverride": { + "description": "Table override settings.", "properties": { - "dataSources": { + "columns": { + "description": "An array of column overrides", "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + "$ref": "#/components/schemas/ColumnOverride" }, "type": "array" }, - "workspaces": { + "path": { + "description": "Path for the table.", + "example": [ + "schema", + "table_name" + ], "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + "type": "string" }, "type": "array" } }, "required": [ - "dataSources", - "workspaces" + "columns", + "path" ], "type": "object" }, - "UserManagementUserGroupMember": { + "TableStatisticsEntry": { "properties": { - "id": { + "columns": { + "items": { + "$ref": "#/components/schemas/ColumnStatisticsEntry" + }, + "type": "array" + }, + "dataSize": { + "description": "Total data size of the table in bytes.", + "format": "int64", + "type": "integer" + }, + "rowCount": { + "description": "Total number of rows in the table.", + "format": "int64", + "type": "integer" + }, + "schemaName": { "type": "string" }, - "name": { - "readOnly": true, + "tableName": { "type": "string" } }, "required": [ - "id" + "columns", + "schemaName", + "tableName" ], "type": "object" }, - "UserManagementUserGroupMembers": { + "TableStatisticsRequest": { "properties": { - "members": { + "schemata": { "items": { - "$ref": "#/components/schemas/UserManagementUserGroupMember" + "type": "string" }, "type": "array" - } - }, - "required": [ - "members" - ], - "type": "object" - }, - "UserManagementUserGroups": { - "properties": { - "totalCount": { - "description": "Total number of groups", - "format": "int32", - "type": "integer" }, - "userGroups": { + "tableNames": { "items": { - "$ref": "#/components/schemas/UserManagementUserGroupsItem" + "type": "string" }, "type": "array" } }, "required": [ - "totalCount", - "userGroups" + "schemata" ], "type": "object" }, - "UserManagementUserGroupsItem": { - "description": "List of groups", + "TableStatisticsResponse": { "properties": { - "dataSources": { + "tables": { "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + "$ref": "#/components/schemas/TableStatisticsEntry" }, "type": "array" }, - "id": { - "type": "string" - }, - "name": { - "description": "Group name", - "example": "admins", - "type": "string" - }, - "organizationAdmin": { - "description": "Is group organization admin", - "example": false, - "type": "boolean" - }, - "userCount": { - "description": "The number of users belonging to the group", - "format": "int32", - "type": "integer" - }, - "workspaces": { + "warnings": { "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + "$ref": "#/components/schemas/TableStatisticsWarning" }, "type": "array" } }, "required": [ - "dataSources", - "id", - "organizationAdmin", - "userCount", - "workspaces" + "tables", + "warnings" ], "type": "object" }, - "UserManagementUsers": { + "TableStatisticsWarning": { "properties": { - "totalCount": { - "description": "The total number of users is based on applied filters.", - "format": "int32", - "type": "integer" + "message": { + "type": "string" }, - "users": { - "items": { - "$ref": "#/components/schemas/UserManagementUsersItem" - }, - "type": "array" + "tableName": { + "type": "string" } }, "required": [ - "totalCount", - "users" + "message" ], "type": "object" }, - "UserManagementUsersItem": { - "description": "List of users", + "TableWarning": { + "description": "Warnings related to single table.", "properties": { - "dataSources": { + "columns": { "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + "$ref": "#/components/schemas/ColumnWarning" }, "type": "array" }, - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { + "message": { + "description": "Warning message related to the table.", "type": "string" }, "name": { - "description": "User name", - "example": "John Wick", + "description": "Table name.", "type": "string" - }, - "organizationAdmin": { - "description": "Is user organization admin", - "example": false, - "type": "boolean" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" - }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/UserGroupIdentifier" - }, - "type": "array" - }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" } }, "required": [ - "dataSources", - "id", - "organizationAdmin", - "systemAccount", - "userGroups", - "workspaces" + "columns", + "name" ], "type": "object" }, - "UserManagementWorkspacePermissionAssignment": { - "description": "Workspace permission assignments for users and userGroups", + "TabularExportExecution": { + "description": "A single pre-executed layer in a multi-layer tabular export.", "properties": { - "accessSource": { - "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", - "enum": [ - "DIRECT", - "GROUP", - "HIERARCHY" - ], - "readOnly": true, + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier for this layer.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, - "hierarchyPermissions": { - "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" - }, - "type": "array" - }, - "id": { - "type": "string" - }, - "name": { - "readOnly": true, + "title": { + "description": "Layer title used for the exported sheet or file name.", + "example": "Pushpins", "type": "string" - }, - "permissions": { - "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" - }, - "type": "array" } }, "required": [ - "hierarchyPermissions", - "id", - "permissions" + "executionResult" ], "type": "object" }, - "UserPermission": { - "description": "List of users", + "TabularExportRequest": { + "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", + "conditionalFormatting": { + "$ref": "#/components/schemas/ConditionalFormatting" + }, + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, - "id": { + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "executions": { + "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", + "items": { + "$ref": "#/components/schemas/TabularExportExecution" + }, + "type": "array" + }, + "fileName": { + "description": "Filename of downloaded file without extension.", + "example": "result", "type": "string" }, - "name": { - "description": "Name of user", - "example": "John Wick", + "format": { + "description": "Expected file format.", + "enum": [ + "CSV", + "XLSX", + "HTML", + "PDF" + ], + "example": "CSV", "type": "string" }, - "permissions": { - "description": "Permissions granted to the user", + "metadata": { + "$ref": "#/components/schemas/JsonNode" + }, + "relatedDashboardId": { + "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + }, + "visualizationObject": { + "description": "Visualization object identifier. Alternative to executionResult property.", + "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", + "type": "string" + }, + "visualizationObjectCustomFilters": { + "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", + "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", "items": { - "$ref": "#/components/schemas/GrantedPermission" + "type": "object" + }, + "type": "array" + }, + "visualizationObjectCustomParameters": { + "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", + "items": { + "$ref": "#/components/schemas/ParameterValue" }, "type": "array" } }, "required": [ - "id" + "fileName", + "format" ], "type": "object" }, - "ValidateByItem": { - "nullable": true, + "TelemetryConfig": { + "description": "Telemetry-related configuration.", "properties": { - "id": { - "description": "Specifies entity used for valid elements computation.", - "type": "string" + "context": { + "$ref": "#/components/schemas/TelemetryContext" }, - "type": { - "description": "Specifies entity type which could be label, attribute, fact, or metric.", - "pattern": "^(label)|(attribute)|(fact)|(metric)$", - "type": "string" + "services": { + "$ref": "#/components/schemas/TelemetryServices" } }, "required": [ - "id", - "type" + "context", + "services" ], "type": "object" }, - "ValidityPeriodCacheRetention": { - "description": "The cache expires once a fixed period elapses since the results were computed.", + "TelemetryContext": { + "description": "The telemetry context.", "properties": { - "type": { - "description": "The cache retention type.", - "enum": [ - "VALIDITY_PERIOD" - ], + "deploymentId": { + "description": "Identification of the deployment.", "type": "string" }, - "validityPeriod": { - "description": "How long the cached results stay valid after they were computed.", - "example": "P1D", - "format": "duration", + "organizationHash": { + "description": "Organization hash.", + "type": "string" + }, + "userHash": { + "description": "User hash.", "type": "string" } }, "required": [ - "type", - "validityPeriod" + "deploymentId", + "organizationHash", + "userHash" ], "type": "object" }, - "Value": { + "TelemetryServices": { + "description": "Available telemetry services.", "properties": { - "value": { - "description": "Value of the alert threshold to compare the metric to.", - "example": 1000, - "type": "number" + "amplitude": { + "$ref": "#/components/schemas/AmplitudeService" + }, + "matomo": { + "$ref": "#/components/schemas/MatomoService" + }, + "openTelemetry": { + "$ref": "#/components/schemas/OpenTelemetryService" } }, - "required": [ - "value" - ], "type": "object" }, - "VisibleFilter": { + "TestDefinitionRequest": { + "description": "A request containing all information for testing data source definition.", "properties": { - "isAllTimeDateFilter": { - "default": false, - "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", - "type": "boolean" + "authenticationType": { + "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", + "enum": [ + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" + ], + "nullable": true, + "type": "string" }, - "localIdentifier": { + "clientId": { + "description": "Id for client based authentication for data sources which supports it.", "type": "string" }, - "title": { + "clientSecret": { + "description": "Secret for client based authentication for data sources which supports it.", "type": "string" - } - }, - "type": "object" - }, - "VisualExportRequest": { - "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", - "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + }, + "parameters": { + "items": { + "$ref": "#/components/schemas/DataSourceParameter" + }, + "type": "array" + }, + "password": { + "description": "Database user password.", + "example": "admin123", "type": "string" }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", + "privateKey": { + "description": "Private key for data sources which supports key-pair authentication.", "type": "string" }, - "metadata": { - "description": "Metadata definition in free-form JSON format.", - "example": "{}", - "type": "object" + "privateKeyPassphrase": { + "description": "Passphrase for a encrypted version of a private key.", + "type": "string" }, - "timezoneId": { - "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", - "example": "Asia/Kolkata", - "nullable": true, + "schema": { + "description": "Database schema.", + "example": "public", + "type": "string" + }, + "token": { + "description": "Secret for token based authentication for data sources which supports it.", + "type": "string" + }, + "type": { + "description": "Type of database, where test should connect to.", + "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" + ], + "example": "POSTGRESQL", + "type": "string" + }, + "url": { + "description": "URL to database in JDBC format, where test should connect to.", + "example": "jdbc:postgresql://localhost:5432/db_name", + "type": "string" + }, + "username": { + "description": "Database user name.", + "example": "dbadmin", "type": "string" } }, "required": [ - "dashboardId", - "fileName" + "type" ], "type": "object" }, - "VisualizationConfig": { - "description": "Visualization config for smart-function rendering.", + "TestDestinationRequest": { + "description": "Request body with notification channel destination to test.", "properties": { - "anomalyDetection": { - "$ref": "#/components/schemas/AnomalyDetectionConfig" - }, - "clustering": { - "$ref": "#/components/schemas/ClusteringConfig" - }, - "forecast": { - "$ref": "#/components/schemas/ForecastConfig" + "destination": { + "$ref": "#/components/schemas/NotificationChannelDestination" }, - "whatIf": { - "$ref": "#/components/schemas/WhatIfScenarioConfig" + "externalRecipients": { + "description": "External recipients of the test result.", + "items": { + "$ref": "#/components/schemas/AutomationExternalRecipient" + }, + "maxItems": 1, + "nullable": true, + "type": "array", + "uniqueItems": true } }, + "required": [ + "destination" + ], "type": "object" }, - "VisualizationObjectExecution": { + "TestLlmProviderByIdRequest": { "properties": { - "filters": { - "description": "Additional AFM filters merged on top of the visualization object's own filters.", + "models": { + "description": "Models overrides.", "items": { - "$ref": "#/components/schemas/FilterDefinition" + "$ref": "#/components/schemas/LlmModel" }, "type": "array" }, - "settings": { - "$ref": "#/components/schemas/ExecutionSettings" + "providerConfig": { + "$ref": "#/components/schemas/LlmProviderConfig" } }, "type": "object" }, - "VisualizationSwitcherWidgetDescriptor": { - "description": "Visualization switcher widget allowing users to toggle between multiple visualizations.", + "TestLlmProviderDefinitionRequest": { "properties": { - "activeVisualizationId": { - "description": "ID of the currently active visualization in the switcher.", - "type": "string" - }, - "filters": { - "description": "Filters currently applied to the dashboard.", + "models": { + "description": "Models to test.", "items": { - "$ref": "#/components/schemas/FilterDefinition" + "$ref": "#/components/schemas/LlmModel" }, "type": "array" }, - "resultId": { - "description": "Signed result ID for the currently active visualization's execution result.", - "type": "string" - }, - "title": { - "description": "Widget title as displayed on the dashboard.", - "type": "string" - }, - "visualizationIds": { - "description": "IDs of all visualizations available in the switcher.", + "providerConfig": { + "$ref": "#/components/schemas/LlmProviderConfig" + } + }, + "required": [ + "providerConfig" + ], + "type": "object" + }, + "TestLlmProviderResponse": { + "properties": { + "modelResults": { + "description": "Per-model test results.", "items": { - "type": "string" + "$ref": "#/components/schemas/ModelTestResult" }, "type": "array" }, - "widgetId": { - "description": "Widget object ID.", + "providerMessage": { + "description": "Message about the provider connectivity test.", "type": "string" }, - "widgetType": { - "enum": [ - "visualizationSwitcher" - ], - "type": "string" + "providerReachable": { + "description": "Whether the LLM provider is reachable.", + "type": "boolean" } }, "required": [ - "activeVisualizationId", - "title", - "visualizationIds", - "widgetId", - "widgetType" + "modelResults", + "providerMessage", + "providerReachable" ], "type": "object" }, - "Webhook": { + "TestNotification": { "allOf": [ + { + "$ref": "#/components/schemas/NotificationContent" + }, { "properties": { - "hasSecretKey": { - "description": "Flag indicating if webhook has a hmac secret key.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "hasToken": { - "description": "Flag indicating if webhook has a token.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "secretKey": { - "description": "Hmac secret key for the webhook signature.", - "example": "secret_key", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "token": { - "description": "Bearer token for the webhook.", - "example": "secret", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "type": { - "description": "The destination type.", - "enum": [ - "WEBHOOK" - ], - "type": "string" - }, - "url": { - "description": "The webhook URL.", - "example": "https://webhook.site/something", - "maxLength": 255, - "pattern": "https?\\://.*", + "message": { "type": "string" } }, "type": "object" } ], - "description": "Webhook destination for notifications. The property url is required on create and update.", "properties": { - "hasSecretKey": { - "description": "Flag indicating if webhook has a hmac secret key.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "hasToken": { - "description": "Flag indicating if webhook has a token.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "secretKey": { - "description": "Hmac secret key for the webhook signature.", - "example": "secret_key", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "token": { - "description": "Bearer token for the webhook.", - "example": "secret", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, "type": { - "description": "The destination type.", "enum": [ - "WEBHOOK" + "TEST" ], "type": "string" - }, - "url": { - "description": "The webhook URL.", - "example": "https://webhook.site/something", - "maxLength": 255, - "pattern": "https?\\://.*", - "type": "string" } }, "required": [ + "message", "type" ], "type": "object" }, - "WebhookAutomationInfo": { + "TestQueryDuration": { + "description": "A structure containing duration of the test queries run on a data source. It is omitted if an error happens.", "properties": { - "dashboardTitle": { - "type": "string" - }, - "dashboardURL": { - "type": "string" - }, - "id": { - "type": "string" - }, - "isCustomDashboardURL": { - "type": "boolean" + "createCacheTable": { + "description": "Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching.", + "example": 235, + "format": "int32", + "type": "integer" }, - "title": { - "type": "string" + "simpleSelect": { + "description": "Field containing duration of a test select query on a data source. In milliseconds.", + "example": 562, + "format": "int32", + "type": "integer" } }, "required": [ - "dashboardURL", - "id", - "isCustomDashboardURL" + "simpleSelect" ], "type": "object" }, - "WebhookMessage": { + "TestRequest": { + "description": "A request containing all information for testing existing data source.", "properties": { - "data": { - "$ref": "#/components/schemas/WebhookMessageData" - }, - "timestamp": { - "format": "date-time", - "type": "string" - }, - "type": { + "authenticationType": { + "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", "enum": [ - "automation-task.completed", - "automation-task.limit-exceeded" + "USERNAME_PASSWORD", + "TOKEN", + "KEY_PAIR", + "CLIENT_SECRET", + "OIDC_PASSTHROUGH" ], + "nullable": true, "type": "string" - } - }, - "required": [ - "data", - "timestamp", - "type" - ], - "type": "object" - }, - "WebhookMessageData": { - "properties": { - "alert": { - "$ref": "#/components/schemas/AlertDescription" - }, - "automation": { - "$ref": "#/components/schemas/WebhookAutomationInfo" - }, - "dashboardTabularExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" - }, - "type": "array" - }, - "details": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "filters": { - "items": { - "$ref": "#/components/schemas/NotificationFilter" - }, - "type": "array" }, - "imageExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" - }, - "type": "array" + "clientId": { + "description": "Id for client based authentication for data sources which supports it.", + "type": "string" }, - "notificationSource": { + "clientSecret": { + "description": "Secret for client based authentication for data sources which supports it.", "type": "string" }, "parameters": { "items": { - "$ref": "#/components/schemas/NotificationParameter" + "$ref": "#/components/schemas/DataSourceParameter" }, "type": "array" }, - "rawExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" - }, - "type": "array" + "password": { + "description": "Database user password.", + "example": "admin123", + "type": "string" }, - "recipients": { - "items": { - "$ref": "#/components/schemas/WebhookRecipient" - }, - "type": "array" + "privateKey": { + "description": "Private key for data sources which supports key-pair authentication.", + "type": "string" }, - "remainingActionCount": { - "format": "int32", - "type": "integer" + "privateKeyPassphrase": { + "description": "Passphrase for a encrypted version of a private key.", + "type": "string" }, - "slidesExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" - }, - "type": "array" + "schema": { + "description": "Database schema.", + "example": "public", + "type": "string" }, - "tabularExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" - }, - "type": "array" + "token": { + "description": "Secret for token based authentication for data sources which supports it.", + "type": "string" }, - "visualExports": { - "items": { - "$ref": "#/components/schemas/ExportResult" - }, - "type": "array" + "url": { + "description": "URL to database in JDBC format, where test should connect to.", + "example": "jdbc:postgresql://localhost:5432/db_name", + "type": "string" + }, + "username": { + "description": "Database user name.", + "example": "dbadmin", + "type": "string" } }, - "required": [ - "automation" - ], "type": "object" }, - "WebhookRecipient": { + "TestResponse": { + "description": "Response from data source testing.", "properties": { - "email": { + "error": { + "description": "Field containing more details in case of a failure. Details are available to a privileged user only.", + "example": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", "type": "string" }, - "id": { - "type": "string" + "queryDurationMillis": { + "$ref": "#/components/schemas/TestQueryDuration" + }, + "successful": { + "description": "A flag indicating whether test passed or not.", + "example": true, + "type": "boolean" } }, "required": [ - "email", - "id" + "successful" ], "type": "object" }, - "WhatIfMeasureAdjustmentConfig": { - "description": "Measure adjustments for this scenario", + "Total": { + "description": "Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension`", "properties": { - "metricId": { - "description": "ID of the metric or fact to adjust", + "function": { + "description": "Aggregation function to compute the total.", + "enum": [ + "SUM", + "MIN", + "MAX", + "AVG", + "MED", + "NAT" + ], + "example": "SUM", "type": "string" }, - "metricType": { - "description": "Type: metric or fact", + "localIdentifier": { + "description": "Total identification within this request. Used e.g. in sorting by a total.", + "example": "firstTotal", "type": "string" }, - "scenarioMaql": { - "description": "Alternative MAQL expression for this scenario", + "metric": { + "description": "The metric for which the total will be computed", + "example": "metric_1", "type": "string" + }, + "totalDimensions": { + "items": { + "$ref": "#/components/schemas/TotalDimension" + }, + "type": "array" } }, "required": [ - "metricId", - "metricType", - "scenarioMaql" + "function", + "localIdentifier", + "metric", + "totalDimensions" ], "type": "object" }, - "WhatIfScenarioConfig": { - "description": "What-if scenario configuration.", + "TotalDimension": { + "description": "A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.", "properties": { - "includeBaseline": { - "description": "Whether baseline (unmodified) values are included", - "type": "boolean" + "dimensionIdentifier": { + "description": "An identifier of a dimension for which the total will be computed.", + "example": "firstDimension", + "pattern": "^[.a-zA-Z0-9_-]+$", + "type": "string" }, - "scenarios": { - "description": "Scenarios with alternative measure calculations", + "totalDimensionItems": { + "description": "List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.", + "example": [ + "measureGroup" + ], "items": { - "$ref": "#/components/schemas/WhatIfScenarioItem" + "type": "string" }, "type": "array" } }, "required": [ - "includeBaseline", - "scenarios" + "dimensionIdentifier", + "totalDimensionItems" ], "type": "object" }, - "WhatIfScenarioItem": { - "description": "Scenarios with alternative measure calculations", + "TotalExecutionResultHeader": { "properties": { - "adjustments": { - "description": "Measure adjustments for this scenario", - "items": { - "$ref": "#/components/schemas/WhatIfMeasureAdjustmentConfig" - }, - "type": "array" - }, - "label": { - "description": "Human-readable scenario label", - "type": "string" + "totalHeader": { + "$ref": "#/components/schemas/TotalResultHeader" } }, "required": [ - "adjustments", - "label" + "totalHeader" ], "type": "object" }, - "WidgetDescriptor": { - "description": "Descriptor for a widget on the dashboard.", - "discriminator": { - "mapping": { - "insight": "#/components/schemas/InsightWidgetDescriptor", - "richText": "#/components/schemas/RichTextWidgetDescriptor", - "visualizationSwitcher": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" - }, - "propertyName": "widgetType" + "TotalResultHeader": { + "description": "Header containing the information related to a subtotal.", + "properties": { + "function": { + "type": "string" + } }, + "required": [ + "function" + ], + "type": "object" + }, + "TrendingObjectItem": { + "description": "Trending analytics catalog objects", "properties": { - "filters": { + "createdAt": { + "description": "Timestamp when object was created.", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "description": "ID of the user who created the object.", + "type": "string" + }, + "datasetId": { + "description": "ID of the associated dataset, if applicable.", + "type": "string" + }, + "datasetTitle": { + "description": "Title of the associated dataset, if applicable.", + "type": "string" + }, + "datasetType": { + "description": "Type of the associated dataset, if applicable.", + "type": "string" + }, + "description": { + "description": "Object description.", + "type": "string" + }, + "id": { + "description": "Object ID.", + "type": "string" + }, + "isHidden": { + "description": "If true, this object is hidden from AI search results by default.", + "type": "boolean" + }, + "isHiddenFromKda": { + "description": "If true, this object is hidden from KDA.", + "type": "boolean" + }, + "metricType": { + "description": "Type of the metric (e.g. MAQL), if applicable.", + "type": "string" + }, + "modifiedAt": { + "description": "Timestamp when object was last modified.", + "format": "date-time", + "type": "string" + }, + "modifiedBy": { + "description": "ID of the user who last modified the object.", + "type": "string" + }, + "tags": { "items": { - "$ref": "#/components/schemas/FilterDefinition" + "description": "Tags assigned to the object.", + "type": "string" }, "type": "array" }, "title": { + "description": "Object title.", + "type": "string" + }, + "type": { + "description": "Object type, e.g. dashboard, visualization, metric.", "type": "string" }, - "widgetId": { + "usageCount": { + "description": "Number of times this object has been used/referenced.", + "format": "int32", + "type": "integer" + }, + "visualizationUrl": { + "description": "URL of the visualization, if applicable.", "type": "string" }, - "widgetType": { + "workspaceId": { + "description": "Workspace ID the object belongs to.", "type": "string" } }, "required": [ + "id", + "tags", "title", - "widgetId", - "widgetType" + "type", + "usageCount", + "workspaceId" ], "type": "object" }, - "WidgetSlidesTemplate": { - "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, + "TrendingObjectsResult": { "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], + "objects": { "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" + "$ref": "#/components/schemas/TrendingObjectItem" }, - "minItems": 1, "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ - "appliedOn" + "objects" ], "type": "object" }, - "WorkflowDashboardSummaryRequestDto": { + "TriggerAutomationRequest": { "properties": { - "customUserPrompt": { - "type": "string" - }, - "dashboardId": { - "type": "string" - }, - "keyMetricIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "referenceQuarter": { - "type": "string" + "automation": { + "$ref": "#/components/schemas/AdHocAutomation" } }, "required": [ - "dashboardId" + "automation" ], "type": "object" }, - "WorkflowDashboardSummaryResponseDto": { + "TriggerQualityIssuesCalculationResponse": { "properties": { - "message": { - "type": "string" - }, - "runId": { + "processId": { + "description": "Process ID for tracking the calculation status", "type": "string" }, "status": { + "description": "Current status of the calculation", + "enum": [ + "RUNNING", + "COMPLETED", + "FAILED", + "CANCELLED", + "DISABLED" + ], "type": "string" } }, "required": [ - "message", - "runId", + "processId", "status" ], "type": "object" }, - "WorkflowStatusResponseDto": { + "UpdateDatabaseDataSourceRequest": { + "description": "Request to update the data source associated with an AI Lake Database instance", "properties": { - "currentPhase": { - "type": "string" - }, - "error": { - "type": "string" - }, - "message": { + "dataSourceId": { + "description": "New identifier for the data source in metadata-api. Must be unique within the organization.", "type": "string" }, - "result": { - "additionalProperties": { - "type": "object" - }, - "type": "object" - }, - "runId": { + "dataSourceName": { + "description": "New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.", "type": "string" }, - "status": { + "oldDataSourceId": { + "description": "Identifier of the existing data source to replace.", "type": "string" } }, "required": [ - "message", - "runId", - "status" + "dataSourceId", + "oldDataSourceId" ], "type": "object" }, - "WorkspaceAutomationIdentifier": { + "UpdateDatabaseDataSourceResponse": { + "description": "Updated data source details for an AI Lake Database instance", "properties": { - "id": { + "dataSourceId": { + "description": "New identifier of the data source in metadata-api.", + "type": "string" + }, + "dataSourceName": { + "description": "New display name of the data source in metadata-api.", "type": "string" } }, "required": [ - "id" + "dataSourceId", + "dataSourceName" ], "type": "object" }, - "WorkspaceAutomationManagementBulkRequest": { + "UploadFileResponse": { + "description": "Information related to the file uploaded to the staging area.", "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" - }, - "type": "array" + "location": { + "description": "Location to use when referencing the uploaded file in subsequent requests.", + "type": "string" } }, "required": [ - "automations" + "location" ], "type": "object" }, - "WorkspaceCacheSettings": { - "description": "Cache settings for the workspace.", + "UploadGeoCollectionFileResponse": { + "description": "Information related to the geo collection file uploaded to the staging area.", "properties": { - "extraCache": { - "description": "Extra cache for the workspace, in bytes.", - "format": "int64", - "type": "integer" + "location": { + "description": "Location to use when referencing the uploaded file in subsequent requests.", + "type": "string" } }, "required": [ - "extraCache" + "location" ], "type": "object" }, - "WorkspaceCacheUsage": { - "description": "Data about a particular workspace cache usage.", + "UserAssignee": { + "description": "List of users", "properties": { - "current": { - "$ref": "#/components/schemas/WorkspaceCurrentCacheUsage" + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" }, - "removalIntervals": { - "description": "List of cache removal intervals for workspace.", - "items": { - "$ref": "#/components/schemas/CacheRemovalInterval" - }, - "type": "array" + "id": { + "type": "string" }, - "settings": { - "$ref": "#/components/schemas/WorkspaceCacheSettings" + "name": { + "description": "User name", + "example": "John Wick", + "type": "string" } }, "required": [ - "current", - "removalIntervals", - "settings" + "id" ], "type": "object" }, - "WorkspaceCurrentCacheUsage": { - "description": "Current cache usage of the workspace.", + "UserGroupAssignee": { + "description": "List of user groups", "properties": { - "cacheAvailable": { - "description": "Cache available for the workspace.", - "format": "int64", - "type": "integer" - }, - "cacheUsed": { - "description": "Cache used by the workspace.", - "format": "int64", - "type": "integer" - }, - "removalPeriodStart": { - "description": "Start timestamp of removal period for the workspace.", - "format": "date-time", + "id": { "type": "string" }, - "removedSinceStart": { - "description": "Bytes removed since start due to insufficient cache for the workspace.", - "format": "int64", - "type": "integer" + "name": { + "description": "User group name", + "example": "admins", + "type": "string" } }, "required": [ - "cacheAvailable", - "cacheUsed", - "removalPeriodStart", - "removedSinceStart" + "id" ], "type": "object" }, - "WorkspaceDashboardSlidesTemplate": { - "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, + "UserGroupIdentifier": { + "description": "A list of groups where user is a member", "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" + "id": { + "type": "string" }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" + "name": { + "type": "string" } }, "required": [ - "appliedOn" + "id" ], "type": "object" }, - "WorkspaceDataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "UserGroupPermission": { + "description": "List of user groups", "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...", + "name": { + "description": "Name of the user group", + "example": "admins", + "type": "string" + }, + "permissions": { + "description": "Permissions granted to the user group", "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" + "$ref": "#/components/schemas/GrantedPermission" }, "type": "array" } @@ -39268,36 +43395,244 @@ ], "type": "object" }, - "WorkspaceIdentifier": { - "description": "A workspace identifier.", - "example": "{ id: demo, type: workspace }", + "UserManagementDataSourcePermissionAssignment": { + "description": "Datasource permission assignments for users and userGroups", "properties": { - "id": { - "description": "Identifier of the workspace.", - "example": "alpha.sales", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type.", + "accessSource": { + "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", "enum": [ - "workspace" + "DIRECT", + "GROUP" ], - "example": "workspace", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Id of the datasource", + "type": "string" + }, + "name": { + "description": "Name of the datasource", + "readOnly": true, "type": "string" + }, + "permissions": { + "items": { + "enum": [ + "MANAGE", + "USE" + ], + "type": "string" + }, + "type": "array" } }, "required": [ "id", - "type" + "permissions" ], "type": "object" }, - "WorkspacePermissionAssignment": { - "description": "Workspace permission assignments", + "UserManagementPermissionAssignments": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "dataSources", + "workspaces" + ], + "type": "object" + }, + "UserManagementUserGroupMember": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UserManagementUserGroupMembers": { + "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/UserManagementUserGroupMember" + }, + "type": "array" + } + }, + "required": [ + "members" + ], + "type": "object" + }, + "UserManagementUserGroups": { + "properties": { + "totalCount": { + "description": "Total number of groups", + "format": "int32", + "type": "integer" + }, + "userGroups": { + "items": { + "$ref": "#/components/schemas/UserManagementUserGroupsItem" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "userGroups" + ], + "type": "object" + }, + "UserManagementUserGroupsItem": { + "description": "List of groups", + "properties": { + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "name": { + "description": "Group name", + "example": "admins", + "type": "string" + }, + "organizationAdmin": { + "description": "Is group organization admin", + "example": false, + "type": "boolean" + }, + "userCount": { + "description": "The number of users belonging to the group", + "format": "int32", + "type": "integer" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "dataSources", + "id", + "organizationAdmin", + "userCount", + "workspaces" + ], + "type": "object" + }, + "UserManagementUsers": { + "properties": { + "totalCount": { + "description": "The total number of users is based on applied filters.", + "format": "int32", + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/components/schemas/UserManagementUsersItem" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "users" + ], + "type": "object" + }, + "UserManagementUsersItem": { + "description": "List of users", + "properties": { + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "description": "User name", + "example": "John Wick", + "type": "string" + }, + "organizationAdmin": { + "description": "Is user organization admin", + "example": false, + "type": "boolean" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + }, + "userGroups": { + "items": { + "$ref": "#/components/schemas/UserGroupIdentifier" + }, + "type": "array" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "dataSources", + "id", + "organizationAdmin", + "systemAccount", + "userGroups", + "workspaces" + ], + "type": "object" + }, + "UserManagementWorkspacePermissionAssignment": { + "description": "Workspace permission assignments for users and userGroups", + "properties": { + "accessSource": { + "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP", + "HIERARCHY" + ], + "readOnly": true, + "type": "string" }, "hierarchyPermissions": { "items": { @@ -39313,6 +43648,7 @@ "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", "CREATE_VISUALIZATION", "CREATE_COMPUTED_ATTRIBUTE", "VIEW" @@ -39321,6 +43657,13 @@ }, "type": "array" }, + "id": { + "type": "string" + }, + "name": { + "readOnly": true, + "type": "string" + }, "permissions": { "items": { "enum": [ @@ -39335,6 +43678,7 @@ "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", "CREATE_VISUALIZATION", "CREATE_COMPUTED_ATTRIBUTE", "VIEW" @@ -39345,12 +43689,14 @@ } }, "required": [ - "assigneeIdentifier" + "hierarchyPermissions", + "id", + "permissions" ], "type": "object" }, - "WorkspaceUser": { - "description": "List of workspace users", + "UserPermission": { + "description": "List of users", "properties": { "email": { "description": "User email address", @@ -39361,9 +43707,16 @@ "type": "string" }, "name": { - "description": "User name", + "description": "Name of user", "example": "John Wick", "type": "string" + }, + "permissions": { + "description": "Permissions granted to the user", + "items": { + "$ref": "#/components/schemas/GrantedPermission" + }, + "type": "array" } }, "required": [ @@ -39371,204 +43724,2294 @@ ], "type": "object" }, - "WorkspaceUserGroup": { - "description": "List of workspace groups", + "ValidateByItem": { + "nullable": true, "properties": { "id": { + "description": "Specifies entity used for valid elements computation.", "type": "string" }, - "name": { - "description": "Group name", - "example": "admins", + "type": { + "description": "Specifies entity type which could be label, attribute, computedAttribute, fact, or metric.", + "pattern": "^(label|attribute|computedAttribute|fact|metric)$", "type": "string" } }, "required": [ - "id" + "id", + "type" ], "type": "object" }, - "WorkspaceUserGroups": { + "ValidityPeriodCacheRetention": { + "description": "The cache expires once a fixed period elapses since the results were computed.", "properties": { - "totalCount": { - "description": "Total number of groups", - "format": "int32", - "type": "integer" + "type": { + "description": "The cache retention type.", + "enum": [ + "VALIDITY_PERIOD" + ], + "type": "string" }, - "userGroups": { + "validityPeriod": { + "description": "How long the cached results stay valid after they were computed.", + "example": "P1D", + "format": "duration", + "type": "string" + } + }, + "required": [ + "type", + "validityPeriod" + ], + "type": "object" + }, + "Value": { + "properties": { + "value": { + "description": "Value of the alert threshold to compare the metric to.", + "example": 1000, + "type": "number" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "VisibleFilter": { + "properties": { + "isAllTimeDateFilter": { + "default": false, + "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", + "type": "boolean" + }, + "localIdentifier": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "VisualExportRequest": { + "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", + "properties": { + "dashboardId": { + "description": "Dashboard identifier", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "fileName": { + "description": "File name to be used for retrieving the pdf document.", + "example": "filename", + "type": "string" + }, + "metadata": { + "description": "Metadata definition in free-form JSON format.", + "example": "{}", + "type": "object" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + } + }, + "required": [ + "dashboardId", + "fileName" + ], + "type": "object" + }, + "VisualizationObjectExecution": { + "properties": { + "filters": { + "description": "Additional AFM filters merged on top of the visualization object's own filters.", "items": { - "$ref": "#/components/schemas/WorkspaceUserGroup" + "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" + }, + "settings": { + "$ref": "#/components/schemas/ExecutionSettings" } }, - "required": [ - "totalCount", - "userGroups" - ], "type": "object" }, - "WorkspaceUsers": { + "VisualizationPermissions": { "properties": { - "totalCount": { - "description": "The total number of users is based on applied filters.", - "format": "int32", - "type": "integer" + "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/WorkspaceUser" + "$ref": "#/components/schemas/UserPermission" }, "type": "array" } }, "required": [ - "totalCount", + "rules", + "userGroups", "users" ], "type": "object" }, - "WorkspaceWidgetSlidesTemplate": { - "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, + "VisualizationPermissionsAssignment": { + "description": "Desired levels of permissions on a visualization for an assignee.", "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], + "permissions": { "items": { "enum": [ - "PDF", - "PPTX" + "EDIT", + "SHARE", + "VIEW" ], "type": "string" }, - "minItems": 1, "type": "array" - }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ - "appliedOn" + "permissions" ], "type": "object" }, - "Xliff": { - "properties": { - "file": { - "items": { - "$ref": "#/components/schemas/File" - }, - "type": "array" + "VisualizationPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/VisualizationPermissionsAssignment" }, - "otherAttributes": { - "additionalProperties": { - "type": "string" + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } }, "type": "object" + } + ], + "description": "Desired levels of visualization permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "VisualizationPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/VisualizationPermissionsAssignment" }, - "space": { - "type": "string", - "xml": { - "attribute": true, - "namespace": "http://www.w3.org/XML/1998/namespace" - } - }, - "srcLang": { - "type": "string", - "xml": { - "attribute": true + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of visualization permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "Webhook": { + "allOf": [ + { + "properties": { + "hasSecretKey": { + "description": "Flag indicating if webhook has a hmac secret key.", + "maxLength": 10000, + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "hasToken": { + "description": "Flag indicating if webhook has a token.", + "maxLength": 10000, + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "secretKey": { + "description": "Hmac secret key for the webhook signature.", + "example": "secret_key", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "token": { + "description": "Bearer token for the webhook.", + "example": "secret", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "The destination type.", + "enum": [ + "WEBHOOK" + ], + "type": "string" + }, + "url": { + "description": "The webhook URL.", + "example": "https://webhook.site/something", + "maxLength": 255, + "pattern": "https?\\://.*", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Webhook destination for notifications. The property url is required on create and update.", + "properties": { + "hasSecretKey": { + "description": "Flag indicating if webhook has a hmac secret key.", + "maxLength": 10000, + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "hasToken": { + "description": "Flag indicating if webhook has a token.", + "maxLength": 10000, + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "secretKey": { + "description": "Hmac secret key for the webhook signature.", + "example": "secret_key", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "token": { + "description": "Bearer token for the webhook.", + "example": "secret", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "The destination type.", + "enum": [ + "WEBHOOK" + ], + "type": "string" + }, + "url": { + "description": "The webhook URL.", + "example": "https://webhook.site/something", + "maxLength": 255, + "pattern": "https?\\://.*", + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "WebhookAutomationInfo": { + "properties": { + "dashboardTitle": { + "type": "string" + }, + "dashboardURL": { + "type": "string" + }, + "id": { + "type": "string" + }, + "isCustomDashboardURL": { + "type": "boolean" + }, + "title": { + "type": "string" + } + }, + "required": [ + "dashboardURL", + "id", + "isCustomDashboardURL" + ], + "type": "object" + }, + "WebhookMessage": { + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookMessageData" + }, + "timestamp": { + "format": "date-time", + "type": "string" + }, + "type": { + "enum": [ + "automation-task.completed", + "automation-task.limit-exceeded" + ], + "type": "string" + } + }, + "required": [ + "data", + "timestamp", + "type" + ], + "type": "object" + }, + "WebhookMessageData": { + "properties": { + "alert": { + "$ref": "#/components/schemas/AlertDescription" + }, + "automation": { + "$ref": "#/components/schemas/WebhookAutomationInfo" + }, + "dashboardTabularExports": { + "items": { + "$ref": "#/components/schemas/ExportResult" + }, + "type": "array" + }, + "details": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "filters": { + "items": { + "$ref": "#/components/schemas/NotificationFilter" + }, + "type": "array" + }, + "imageExports": { + "items": { + "$ref": "#/components/schemas/ExportResult" + }, + "type": "array" + }, + "notificationSource": { + "type": "string" + }, + "parameters": { + "items": { + "$ref": "#/components/schemas/NotificationParameter" + }, + "type": "array" + }, + "rawExports": { + "items": { + "$ref": "#/components/schemas/ExportResult" + }, + "type": "array" + }, + "recipients": { + "items": { + "$ref": "#/components/schemas/WebhookRecipient" + }, + "type": "array" + }, + "remainingActionCount": { + "format": "int32", + "type": "integer" + }, + "slidesExports": { + "items": { + "$ref": "#/components/schemas/ExportResult" + }, + "type": "array" + }, + "tabularExports": { + "items": { + "$ref": "#/components/schemas/ExportResult" + }, + "type": "array" + }, + "visualExports": { + "items": { + "$ref": "#/components/schemas/ExportResult" + }, + "type": "array" + } + }, + "required": [ + "automation" + ], + "type": "object" + }, + "WebhookRecipient": { + "properties": { + "email": { + "type": "string" + }, + "id": { + "type": "string" + } + }, + "required": [ + "email", + "id" + ], + "type": "object" + }, + "WidgetSlidesTemplate": { + "description": "Template for 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" + }, + "WorkspaceAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" + }, + "type": "array" + } + }, + "required": [ + "automations" + ], + "type": "object" + }, + "WorkspaceCacheSettings": { + "description": "Cache settings for the workspace.", + "properties": { + "extraCache": { + "description": "Extra cache for the workspace, in bytes.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "extraCache" + ], + "type": "object" + }, + "WorkspaceCacheUsage": { + "description": "Data about a particular workspace cache usage.", + "properties": { + "current": { + "$ref": "#/components/schemas/WorkspaceCurrentCacheUsage" + }, + "removalIntervals": { + "description": "List of cache removal intervals for workspace.", + "items": { + "$ref": "#/components/schemas/CacheRemovalInterval" + }, + "type": "array" + }, + "settings": { + "$ref": "#/components/schemas/WorkspaceCacheSettings" + } + }, + "required": [ + "current", + "removalIntervals", + "settings" + ], + "type": "object" + }, + "WorkspaceCurrentCacheUsage": { + "description": "Current cache usage of the workspace.", + "properties": { + "cacheAvailable": { + "description": "Cache available for the workspace.", + "format": "int64", + "type": "integer" + }, + "cacheUsed": { + "description": "Cache used by the workspace.", + "format": "int64", + "type": "integer" + }, + "removalPeriodStart": { + "description": "Start timestamp of removal period for the workspace.", + "format": "date-time", + "type": "string" + }, + "removedSinceStart": { + "description": "Bytes removed since start due to insufficient cache for the workspace.", + "format": "int64", + "type": "integer" + } + }, + "required": [ + "cacheAvailable", + "cacheUsed", + "removalPeriodStart", + "removedSinceStart" + ], + "type": "object" + }, + "WorkspaceDashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "WorkspaceDataSource": { + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties": { + "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" + }, + "WorkspaceIdentifier": { + "description": "A workspace identifier.", + "example": "{ id: demo, type: workspace }", + "properties": { + "id": { + "description": "Identifier of the workspace.", + "example": "alpha.sales", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "A type.", + "enum": [ + "workspace" + ], + "example": "workspace", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "WorkspacePermissionAssignment": { + "description": "Workspace permission assignments", + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "hierarchyPermissions": { + "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" + }, + "permissions": { + "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" + } + }, + "required": [ + "assigneeIdentifier" + ], + "type": "object" + }, + "WorkspaceUser": { + "description": "List of workspace users", + "properties": { + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "description": "User name", + "example": "John Wick", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceUserGroup": { + "description": "List of workspace groups", + "properties": { + "id": { + "type": "string" + }, + "name": { + "description": "Group name", + "example": "admins", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceUserGroups": { + "properties": { + "totalCount": { + "description": "Total number of groups", + "format": "int32", + "type": "integer" + }, + "userGroups": { + "items": { + "$ref": "#/components/schemas/WorkspaceUserGroup" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "userGroups" + ], + "type": "object" + }, + "WorkspaceUsers": { + "properties": { + "totalCount": { + "description": "The total number of users is based on applied filters.", + "format": "int32", + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/components/schemas/WorkspaceUser" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "users" + ], + "type": "object" + }, + "WorkspaceWidgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "Xliff": { + "properties": { + "file": { + "items": { + "$ref": "#/components/schemas/File" + }, + "type": "array" + }, + "otherAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "space": { + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } + }, + "srcLang": { + "type": "string", + "xml": { + "attribute": true + } + }, + "trgLang": { + "type": "string", + "xml": { + "attribute": true + } + }, + "version": { + "type": "string", + "xml": { + "attribute": true + } + } + }, + "required": [ + "file" + ], + "type": "object", + "xml": { + "name": "xliff", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } + } + } + }, + "info": { + "title": "OpenAPI definition", + "version": "v0" + }, + "openapi": "3.0.1", + "paths": { + "/api/v1/actions/ai/llmEndpoint/test": { + "post": { + "deprecated": true, + "description": "Permanently removed. Use POST /api/v1/actions/ai/llmProvider/test instead. Always returns 410 Gone.", + "operationId": "validateLLMEndpoint", + "responses": { + "410": { + "content": {}, + "description": "Gone" + } + }, + "summary": "Validate LLM Endpoint (Removed)", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test": { + "post": { + "deprecated": true, + "description": "Permanently removed. Use POST /api/v1/actions/ai/llmProvider/{llmProviderId}/test instead. Always returns 410 Gone.", + "operationId": "validateLLMEndpointById", + "parameters": [ + { + "in": "path", + "name": "llmEndpointId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "410": { + "content": {}, + "description": "Gone" + } + }, + "summary": "Validate LLM Endpoint By Id (Removed)", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/ai/llmProvider/listModels": { + "post": { + "description": "Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", + "operationId": "listLlmProviderModels", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "List LLM Provider Models", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/ai/llmProvider/test": { + "post": { + "description": "Tests LLM provider connectivity with a full definition.", + "operationId": "testLlmProvider", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestLlmProviderDefinitionRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestLlmProviderResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Test LLM Provider", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels": { + "post": { + "description": "Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", + "operationId": "listLlmProviderModelsById", + "parameters": [ + { + "in": "path", + "name": "llmProviderId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "List LLM Provider Models By Id", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/ai/llmProvider/{llmProviderId}/test": { + "post": { + "description": "Tests an existing LLM provider connectivity by its ID.", + "operationId": "testLlmProviderById", + "parameters": [ + { + "in": "path", + "name": "llmProviderId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestLlmProviderByIdRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestLlmProviderResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "Test LLM Provider By Id", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/collectCacheUsage": { + "get": { + "description": "Get the detailed data about how much cache your organization is currently using, broken down by individual workspaces.", + "operationId": "collectCacheUsage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CacheUsageData" + } + } + }, + "description": "OK" + } + }, + "summary": "Collect data about the current cache usage", + "tags": [ + "Cache usage", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/collectUsage": { + "get": { + "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", + "operationId": "allPlatformUsage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/PlatformUsage" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "Info about the platform usage.", + "tags": [ + "Usage", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", + "operationId": "particularPlatformUsage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlatformUsageRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/PlatformUsage" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "Info about the platform usage for particular items.", + "tags": [ + "Usage", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/customGeoCollection/convert": { + "post": { + "description": "Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.", + "operationId": "convertGeoFile", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConvertGeoFileRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ConvertGeoFileResponse" + } + } + }, + "description": "Conversion was successful." + }, + "400": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ConvertGeoFileResponse" + } + } + }, + "description": "Invalid request or unsupported file format." + } + }, + "summary": "Convert a geo file to GeoParquet format", + "tags": [ + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/customGeoCollection/staging/upload": { + "post": { + "description": "Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.", + "operationId": "customGeoCollectionStagingUpload", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "file": { + "description": "The geo collection file to upload. Supported formats: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip).", + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/UploadGeoCollectionFileResponse" + } + } + }, + "description": "Upload was successful." + } + }, + "summary": "Upload a geo collection file to the staging area", + "tags": [ + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/customGeoCollection/{collectionId}/import": { + "post": { + "description": "Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).", + "operationId": "importCustomGeoCollection", + "parameters": [ + { + "in": "path", + "name": "collectionId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportGeoCollectionRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "*/*": { + "schema": { + "$ref": "#/components/schemas/ImportGeoCollectionResponse" + } + } + }, + "description": "Successful import." + } + }, + "summary": "Import custom geo collection", + "tags": [ + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSource/test": { + "post": { + "description": "Test if it is possible to connect to a database using a connection provided by the data source definition in the request body.", + "operationId": "testDataSourceDefinition", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestDefinitionRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "An example of a successful connection": { + "description": "An example of a successful connection", + "value": { + "queryDurationMillis": { + "createCacheTable": 235, + "simpleSelect": 562 + }, + "successful": true + } + }, + "An example of an unsuccessful connection": { + "description": "An example of an unsuccessful connection", + "value": { + "error": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", + "successful": false + } + } + }, + "schema": { + "$ref": "#/components/schemas/TestResponse" + } + } + }, + "description": "The result of the test of a data source connection." + } + }, + "summary": "Test connection by data source definition", + "tags": [ + "Test Connection", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal organization permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics": { + "post": { + "description": "(EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source.", + "operationId": "columnStatistics", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ColumnStatisticsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ColumnStatisticsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "(EXPERIMENTAL) Compute column statistics", + "tags": [ + "Computation", + "actions" + ] + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel": { + "post": { + "description": "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", + "operationId": "generateLogicalModel", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateLdmRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeclarativeModel" + } + } + }, + "description": "LDM generated successfully." + } + }, + "summary": "Generate logical data model (LDM) from physical data model (PDM)", + "tags": [ + "Generate Logical Data Model", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/managePermissions": { + "post": { + "description": "Manage Permissions for a Data Source", + "operationId": "manageDataSourcePermissions", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of data source permissions assignments", + "items": { + "$ref": "#/components/schemas/DataSourcePermissionAssignment" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Manage Permissions for a Data Source", + "tags": [ + "Manage Permissions", + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/scan": { + "post": { + "description": "It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns.", + "operationId": "scanDataSource", + "parameters": [ + { + "description": "Data source id", + "example": "myPostgres", + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScanRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "An example of a successful scan": { + "description": "An example of a successful scan", + "value": { + "pdm": { + "tables": [ + { + "columns": [ + { + "dataType": "NUMERIC", + "isPrimaryKey": false, + "name": "budget" + }, + { + "dataType": "STRING", + "isPrimaryKey": false, + "name": "category" + }, + { + "dataType": "NUMERIC", + "isPrimaryKey": false, + "name": "spend" + } + ], + "id": "campaign_channels", + "path": [ + "demo", + "campaign_channels" + ], + "type": "TABLE" + } + ] + }, + "warnings": [] + } + } + }, + "schema": { + "$ref": "#/components/schemas/ScanResultPdm" + } + } + }, + "description": "The result of the scan." + } + }, + "summary": "Scan a database to get a physical data model (PDM)", + "tags": [ + "Scanning", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "USE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/scanSchemata": { + "get": { + "description": "It scans a database and reads metadata. The result of the request contains a list of schema names of a database.", + "operationId": "getDataSourceSchemata", + "parameters": [ + { + "description": "Data source id", + "example": "myPostgres", + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "An example of a successful scan": { + "description": "An example of a successful scan", + "value": { + "schemaNames": [ + "demo", + "public" + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/DataSourceSchemata" + } + } + }, + "description": "The result of the scan schemata" + } + }, + "summary": "Get a list of schema names of a database", + "tags": [ + "Scanning", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/scanSql": { + "post": { + "description": "It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query", + "operationId": "scanSql", + "parameters": [ + { + "description": "Data source id", + "example": "myPostgres", + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScanSqlRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "An example of a successful scan": { + "description": "An example of a successful scan", + "value": { + "columns": [ + { + "dataType": "NUMERIC", + "name": "budget" + }, + { + "dataType": "STRING", + "name": "category" + }, + { + "dataType": "NUMERIC", + "name": "spend" + } + ], + "dataPreview": [ + [ + "1000", + "campaign1", + "458.8" + ], + [ + "1800", + "campaign2", + "144" + ] + ] + } + } + }, + "schema": { + "$ref": "#/components/schemas/ScanSqlResponse" + } + } + }, + "description": "The result of the scan." + } + }, + "summary": "Collect metadata about SQL query", + "tags": [ + "Scanning", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/scanStatistics": { + "post": { + "description": "(BETA) Reads the statistics the database already maintains in its own catalog, without scanning any data. Supported for StarRocks (both internal catalog for native/PIPE tables and external catalog for Iceberg tables), BigQuery, PostgreSQL, Redshift, Snowflake, Vertica, SQL Server, Azure SQL, MySQL, MariaDB and SingleStore. Statistics include row counts and data sizes, and, where the database exposes them, NDV (number of distinct values), null counts and min/max values. Returns an empty result for a data source whose database exposes no such catalog. Also returns an empty result for a data source that sets disableStatistics.", + "operationId": "scanStatistics", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TableStatisticsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TableStatisticsResponse" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Collect physical table and column statistics from a data source", + "tags": [ + "Data Source - Statistics", + "actions" + ], + "x-gdc-security-info": { + "description": "Permission required to scan statistics.", + "permissions": [ + "USE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/test": { + "post": { + "description": "Test if it is possible to connect to a database using an existing data source definition.", + "operationId": "testDataSource", + "parameters": [ + { + "description": "Data source id", + "example": "myPostgres", + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TestRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "examples": { + "An example of a successful connection": { + "description": "An example of a successful connection", + "value": { + "queryDurationMillis": { + "createCacheTable": 235, + "simpleSelect": 562 + }, + "successful": true + } + }, + "An example of an unsuccessful connection": { + "description": "An example of an unsuccessful connection", + "value": { + "error": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", + "successful": false + } + } + }, + "schema": { + "$ref": "#/components/schemas/TestResponse" + } + } + }, + "description": "The result of the test of a data source connection." + } + }, + "summary": "Test data source connection by data source id", + "tags": [ + "Test Connection", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to test a data source.", + "permissions": [ + "USE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { + "post": { + "description": "Notification sets up all reports to be computed again with new data.", + "operationId": "registerUploadNotification", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "An upload notification has been successfully registered." + } + }, + "summary": "Register an upload notification", + "tags": [ + "Invalidate Cache", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/deleteFiles": { + "post": { + "description": "Delete the files in the given data source.", + "operationId": "deleteFiles", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteFilesRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "Successful deletion." + } + }, + "summary": "Delete datasource files", + "tags": [ + "Data source files deletion", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/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.", + "operationId": "importCsv", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportCsvRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ImportCsvResponse" + }, + "type": "array" + } + } + }, + "description": "Successful import." + } + }, + "summary": "Import CSV", + "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.", + "operationId": "listFiles", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/GdStorageFile" + }, + "type": "array" + } + } + }, + "description": "Successful listing." + } + }, + "summary": "List datasource files", + "tags": [ + "Data source files listing", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests": { + "post": { + "description": "Read the manifests of the CSV files in the given data source.", + "operationId": "readCsvFileManifests", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReadCsvFileManifestsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ReadCsvFileManifestsResponse" + }, + "type": "array" + } + } + }, + "description": "Successful listing." + } + }, + "summary": "Read CSV file manifests", + "tags": [ + "Data source files manifest read", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/fileStorage/staging/analyzeCsv": { + "post": { + "description": "Analyzes CSV files at the given locations", + "operationId": "analyzeCsv", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyzeCsvRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/AnalyzeCsvResponse" + }, + "type": "array" + } + } + }, + "description": "Successful analysis." + } + }, + "summary": "Analyze CSV", + "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.", + "operationId": "stagingUpload", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "file": { + "description": "The file to upload.", + "format": "binary", + "type": "string" + } + }, + "required": [ + "file" + ], + "type": "object" + } } - }, - "trgLang": { - "type": "string", - "xml": { - "attribute": true + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileResponse" + } + } + }, + "description": "Upload was successful." + } + }, + "summary": "Upload a file to the staging area", + "tags": [ + "Data source staging location", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/invite": { + "post": { + "description": "Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.", + "operationId": "processInvitation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Invitation" + } } }, - "version": { - "type": "string", - "xml": { - "attribute": true - } + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" } }, - "required": [ - "file" + "summary": "Invite User", + "tags": [ + "User Authorization", + "actions" ], - "type": "object", - "xml": { - "name": "xliff", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" + "x-gdc-security-info": { + "description": "Permissions required to add an invitation.", + "permissions": [ + "MANAGE" + ] } } - } - }, - "info": { - "title": "OpenAPI definition", - "version": "v0" - }, - "openapi": "3.0.1", - "paths": { - "/api/v1/actions/ai/llmEndpoint/test": { + }, + "/api/v1/actions/ipAllowlistPolicies/{id}/addTargets": { "post": { - "deprecated": true, - "description": "Permanently removed. Use POST /api/v1/actions/ai/llmProvider/test instead. Always returns 410 Gone.", - "operationId": "validateLLMEndpoint", + "operationId": "addTargets", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IpAllowlistPolicyTargets" + } + } + }, + "required": true + }, "responses": { - "410": { + "204": { "content": {}, - "description": "Gone" + "description": "No Content" } }, - "summary": "Validate LLM Endpoint (Removed)", + "summary": "Add targets to IP allowlist policy", "tags": [ - "Smart Functions", + "Organization - Entity APIs", "actions" ] } }, - "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test": { + "/api/v1/actions/ipAllowlistPolicies/{id}/removeTargets": { "post": { - "deprecated": true, - "description": "Permanently removed. Use POST /api/v1/actions/ai/llmProvider/{llmProviderId}/test instead. Always returns 410 Gone.", - "operationId": "validateLLMEndpointById", + "operationId": "removeTargets", "parameters": [ { "in": "path", - "name": "llmEndpointId", + "name": "id", "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IpAllowlistPolicyTargets" + } + } + }, + "required": true + }, "responses": { - "410": { + "204": { "content": {}, - "description": "Gone" + "description": "No Content" } }, - "summary": "Validate LLM Endpoint By Id (Removed)", + "summary": "Remove targets from IP allowlist policy", "tags": [ - "Smart Functions", + "Organization - Entity APIs", "actions" ] } }, - "/api/v1/actions/ai/llmProvider/listModels": { + "/api/v1/actions/notificationChannels/test": { "post": { - "description": "Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", - "operationId": "listLlmProviderModels", + "description": "Tests the notification channel by sending a test notification.", + "operationId": "testNotificationChannel", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListLlmProviderModelsRequest" + "$ref": "#/components/schemas/TestDestinationRequest" } } }, @@ -39578,66 +46021,160 @@ "200": { "content": { "application/json": { + "examples": { + "An example of a successful connection": { + "description": "An example of a successful connection", + "value": { + "successful": true + } + }, + "An example of an unsuccessful connection": { + "description": "An example of an unsuccessful connection", + "value": { + "error": "Authentication failed", + "successful": false + } + } + }, "schema": { - "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + "$ref": "#/components/schemas/TestResponse" } } }, - "description": "OK" + "description": "The result of the test of a notification channel connection." } }, - "summary": "List LLM Provider Models", + "summary": "Test notification channel.", "tags": [ - "Smart Functions", + "Notification Channels", "actions" ] } }, - "/api/v1/actions/ai/llmProvider/test": { + "/api/v1/actions/notificationChannels/{notificationChannelId}/test": { "post": { - "description": "Tests LLM provider connectivity with a full definition.", - "operationId": "testLlmProvider", + "description": "Tests the existing notification channel by sending a test notification.", + "operationId": "testExistingNotificationChannel", + "parameters": [ + { + "in": "path", + "name": "notificationChannelId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestLlmProviderDefinitionRequest" + "$ref": "#/components/schemas/TestDestinationRequest" } } - }, - "required": true + } }, "responses": { "200": { "content": { "application/json": { + "examples": { + "An example of a successful connection": { + "description": "An example of a successful connection", + "value": { + "successful": true + } + }, + "An example of an unsuccessful connection": { + "description": "An example of an unsuccessful connection", + "value": { + "error": "Authentication failed", + "successful": false + } + } + }, "schema": { - "$ref": "#/components/schemas/TestLlmProviderResponse" + "$ref": "#/components/schemas/TestResponse" } } }, - "description": "OK" + "description": "The result of the test of a notification channel connection." } }, - "summary": "Test LLM Provider", + "summary": "Test existing notification channel.", "tags": [ - "Smart Functions", + "Notification Channels", "actions" ] } }, - "/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels": { - "post": { - "description": "Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", - "operationId": "listLlmProviderModelsById", + "/api/v1/actions/notifications": { + "get": { + "description": "Get latest in-platform notifications for the current user.", + "operationId": "getNotifications", "parameters": [ { - "in": "path", - "name": "llmProviderId", - "required": true, + "description": "Workspace ID to filter notifications by.", + "in": "query", + "name": "workspaceId", + "required": false, "schema": { "type": "string" - } + }, + "style": "form" + }, + { + "description": "Filter notifications by read status.", + "in": "query", + "name": "isRead", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "description": "Zero-based page index (0..N)", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": "0", + "minimum": 0, + "type": "string" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": "20", + "minimum": 1, + "type": "string" + }, + "style": "form" + }, + { + "description": "Additional meta information to include in the response.", + "explode": true, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "items": { + "enum": [ + "total", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -39645,81 +46182,289 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ListLlmProviderModelsResponse" + "$ref": "#/components/schemas/Notifications" } } }, "description": "OK" } }, - "summary": "List LLM Provider Models By Id", + "summary": "Get latest notifications.", "tags": [ - "Smart Functions", + "Notification Channels", + "actions" + ] + } + }, + "/api/v1/actions/notifications/markAsRead": { + "post": { + "description": "Mark all user in-platform notifications as read.", + "operationId": "markAsReadNotificationAll", + "parameters": [ + { + "description": "Workspace ID where to mark notifications as read.", + "in": "query", + "name": "workspaceId", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Mark all notifications as read.", + "tags": [ + "Notification Channels", + "actions" + ] + } + }, + "/api/v1/actions/notifications/{notificationId}/markAsRead": { + "post": { + "description": "Mark in-platform notification by its ID as read.", + "operationId": "markAsReadNotification", + "parameters": [ + { + "description": "Notification ID to mark as read.", + "in": "path", + "name": "notificationId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Mark notification as read.", + "tags": [ + "Notification Channels", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/delete": { + "post": { + "operationId": "deleteOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Delete selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/pause": { + "post": { + "operationId": "pauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Pause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/unpause": { + "post": { + "operationId": "unpauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unpause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/unsubscribe": { + "delete": { + "operationId": "unsubscribeAllAutomations", + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unsubscribe from all automations in all workspaces", + "tags": [ + "Automations", + "actions" + ] + }, + "post": { + "operationId": "unsubscribeOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unsubscribe from selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/managePermissions": { + "post": { + "description": "Manage Permissions for a Organization", + "operationId": "manageOrganizationPermissions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of organization permissions assignments", + "items": { + "$ref": "#/components/schemas/OrganizationPermissionAssignment" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Manage Permissions for a Organization", + "tags": [ + "Permissions", "actions" ] } }, - "/api/v1/actions/ai/llmProvider/{llmProviderId}/test": { + "/api/v1/actions/organization/reloadObservabilityLayout": { + "post": { + "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", + "operationId": "reloadObservabilityLayout", + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Reload the managed AI observability layout", + "tags": [ + "Observability", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/switchActiveIdentityProvider": { "post": { - "description": "Tests an existing LLM provider connectivity by its ID.", - "operationId": "testLlmProviderById", - "parameters": [ - { - "in": "path", - "name": "llmProviderId", - "required": true, - "schema": { - "type": "string" - } - } - ], + "description": "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", + "operationId": "switchActiveIdentityProvider", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestLlmProviderByIdRequest" + "$ref": "#/components/schemas/SwitchIdentityProviderRequest" } } - } + }, + "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestLlmProviderResponse" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "Test LLM Provider By Id", + "summary": "Switch Active Identity Provider", "tags": [ - "Smart Functions", + "Identity Providers", "actions" ] } }, - "/api/v1/actions/collectCacheUsage": { - "get": { - "description": "Get the detailed data about how much cache your organization is currently using, broken down by individual workspaces.", - "operationId": "collectCacheUsage", + "/api/v1/actions/organization/syncMetadata": { + "post": { + "description": "Enqueues an organization-scoped metadata resync, fanning out the organization's current metadata to GenAI, GW Forge, and Automations. Requires organization MANAGE permission. Requests are deduplicated while a resync session is pending for the organization.", + "operationId": "syncMetadata", "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CacheUsageData" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "Collect data about the current cache usage", + "summary": "Trigger metadata synchronization", "tags": [ - "Cache usage", + "Metadata Synchronization", "actions" ], "x-gdc-security-info": { @@ -39730,17 +46475,17 @@ } } }, - "/api/v1/actions/collectUsage": { + "/api/v1/actions/resolveEntitlements": { "get": { - "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", - "operationId": "allPlatformUsage", + "description": "Resolves values of available entitlements for the organization.", + "operationId": "resolveAllEntitlements", "responses": { "200": { "content": { "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/PlatformUsage" + "$ref": "#/components/schemas/ApiEntitlement" }, "type": "array" } @@ -39749,26 +46494,26 @@ "description": "OK" } }, - "summary": "Info about the platform usage.", + "summary": "Values for all public entitlements.", "tags": [ - "Usage", + "Entitlement", "actions" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "post": { - "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", - "operationId": "particularPlatformUsage", + "description": "Resolves values for requested entitlements in the organization.", + "operationId": "resolveRequestedEntitlements", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PlatformUsageRequest" + "$ref": "#/components/schemas/EntitlementsRequest" } } }, @@ -39780,7 +46525,7 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/PlatformUsage" + "$ref": "#/components/schemas/ApiEntitlement" }, "type": "array" } @@ -39789,125 +46534,68 @@ "description": "OK" } }, - "summary": "Info about the platform usage for particular items.", + "summary": "Values for requested public entitlements.", "tags": [ - "Usage", + "Entitlement", "actions" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/actions/customGeoCollection/convert": { - "post": { - "description": "Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.", - "operationId": "convertGeoFile", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConvertGeoFileRequest" - } + "/api/v1/actions/resolveSettings": { + "get": { + "description": "Resolves values for all settings without workspace by current user, organization, or default settings.", + "operationId": "resolveAllSettingsWithoutWorkspace", + "parameters": [ + { + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", + "required": false, + "schema": { + "default": false, + "type": "boolean" } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/ConvertGeoFileResponse" - } - } - }, - "description": "Conversion was successful." - }, - "400": { - "content": { - "*/*": { - "schema": { - "$ref": "#/components/schemas/ConvertGeoFileResponse" - } - } - }, - "description": "Invalid request or unsupported file format." } - }, - "summary": "Convert a geo file to GeoParquet format", - "tags": [ - "actions" ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/customGeoCollection/staging/upload": { - "post": { - "description": "Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.", - "operationId": "customGeoCollectionStagingUpload", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "properties": { - "file": { - "description": "The geo collection file to upload. Supported formats: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip).", - "format": "binary", - "type": "string" - } - }, - "required": [ - "file" - ], - "type": "object" - } - } - } - }, "responses": { "200": { "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/UploadGeoCollectionFileResponse" + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" } } }, - "description": "Upload was successful." + "description": "Values for selected settings." } }, - "summary": "Upload a geo collection file to the staging area", + "summary": "Values for all settings without workspace.", "tags": [ + "Reporting - Settings", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/customGeoCollection/{collectionId}/import": { + ] + }, "post": { - "description": "Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).", - "operationId": "importCustomGeoCollection", + "description": "Resolves values for selected settings without workspace by current user, organization, or default settings.", + "operationId": "resolveSettingsWithoutWorkspace", "parameters": [ { - "in": "path", - "name": "collectionId", - "required": true, + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", + "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } } ], @@ -39915,7 +46603,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImportGeoCollectionRequest" + "$ref": "#/components/schemas/ResolveSettingsRequest" } } }, @@ -39924,36 +46612,33 @@ "responses": { "200": { "content": { - "*/*": { + "application/json": { "schema": { - "$ref": "#/components/schemas/ImportGeoCollectionResponse" + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" } } }, - "description": "Successful import." + "description": "Values for selected settings." } }, - "summary": "Import custom geo collection", + "summary": "Values for selected settings without workspace.", "tags": [ + "Reporting - Settings", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/dataSource/test": { + "/api/v1/actions/userManagement/assignPermissions": { "post": { - "description": "Test if it is possible to connect to a database using a connection provided by the data source definition in the request body.", - "operationId": "testDataSourceDefinition", + "operationId": "assignPermissions", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestDefinitionRequest" + "$ref": "#/components/schemas/PermissionsAssignment" } } }, @@ -39961,67 +46646,26 @@ }, "responses": { "200": { - "content": { - "application/json": { - "examples": { - "An example of a successful connection": { - "description": "An example of a successful connection", - "value": { - "queryDurationMillis": { - "createCacheTable": 235, - "simpleSelect": 562 - }, - "successful": true - } - }, - "An example of an unsuccessful connection": { - "description": "An example of an unsuccessful connection", - "value": { - "error": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", - "successful": false - } - } - }, - "schema": { - "$ref": "#/components/schemas/TestResponse" - } - } - }, - "description": "The result of the test of a data source connection." + "content": {}, + "description": "OK" } }, - "summary": "Test connection by data source definition", "tags": [ - "Test Connection", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal organization permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "User management" + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics": { + "/api/v1/actions/userManagement/removeUsersUserGroups": { "post": { - "description": "(EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source.", - "operationId": "columnStatistics", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } - } - ], + "operationId": "removeUsersUserGroups", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ColumnStatisticsRequest" + "items": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "type": "array" } } }, @@ -40029,42 +46673,23 @@ }, "responses": { "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ColumnStatisticsResponse" - } - } - }, + "content": {}, "description": "OK" } }, - "summary": "(EXPERIMENTAL) Compute column statistics", "tags": [ - "Computation", - "actions" + "User management" ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel": { + "/api/v1/actions/userManagement/revokePermissions": { "post": { - "description": "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", - "operationId": "generateLogicalModel", - "parameters": [ - { - "in": "path", - "name": "dataSourceId", - "required": true, - "schema": { - "type": "string" - } - } - ], + "operationId": "revokePermissions", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GenerateLdmRequest" + "$ref": "#/components/schemas/PermissionsAssignment" } } }, @@ -40072,173 +46697,139 @@ }, "responses": { "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeclarativeModel" - } - } - }, - "description": "LDM generated successfully." + "content": {}, + "description": "OK" } }, - "summary": "Generate logical data model (LDM) from physical data model (PDM)", "tags": [ - "Generate Logical Data Model", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "User management" + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/managePermissions": { - "post": { - "description": "Manage Permissions for a Data Source", - "operationId": "manageDataSourcePermissions", + "/api/v1/actions/userManagement/userGroups": { + "get": { + "operationId": "listUserGroups", "parameters": [ { - "in": "path", - "name": "dataSourceId", - "required": true, + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name. Note that user name is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, "schema": { "type": "string" - } + }, + "style": "form" + }, + { + "description": "Filter by workspaceId.", + "example": "workspace=demo", + "in": "query", + "name": "workspace", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter by dataSourceId.", + "example": "dataSource=demo-test-ds", + "in": "query", + "name": "dataSource", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of data source permissions assignments", - "items": { - "$ref": "#/components/schemas/DataSourcePermissionAssignment" - }, - "type": "array" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUserGroups" + } + } + }, + "description": "OK" } }, - "summary": "Manage Permissions for a Data Source", "tags": [ - "Manage Permissions", - "Permissions", - "actions" + "User management" ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/scan": { + "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers": { "post": { - "description": "It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns.", - "operationId": "scanDataSource", + "operationId": "addGroupMembers", "parameters": [ { - "description": "Data source id", - "example": "myPostgres", "in": "path", - "name": "dataSourceId", + "name": "userGroupId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScanRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "An example of a successful scan": { - "description": "An example of a successful scan", - "value": { - "pdm": { - "tables": [ - { - "columns": [ - { - "dataType": "NUMERIC", - "isPrimaryKey": false, - "name": "budget" - }, - { - "dataType": "STRING", - "isPrimaryKey": false, - "name": "category" - }, - { - "dataType": "NUMERIC", - "isPrimaryKey": false, - "name": "spend" - } - ], - "id": "campaign_channels", - "path": [ - "demo", - "campaign_channels" - ], - "type": "TABLE" - } - ] - }, - "warnings": [] - } - } - }, - "schema": { - "$ref": "#/components/schemas/ScanResultPdm" - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUserGroupMembers" } - }, - "description": "The result of the scan." + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "Scan a database to get a physical data model (PDM)", "tags": [ - "Scanning", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "USE" - ] - } + "User management" + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/scanSchemata": { + "/api/v1/actions/userManagement/userGroups/{userGroupId}/members": { "get": { - "description": "It scans a database and reads metadata. The result of the request contains a list of schema names of a database.", - "operationId": "getDataSourceSchemata", + "operationId": "getGroupMembers", "parameters": [ { - "description": "Data source id", - "example": "myPostgres", "in": "path", - "name": "dataSourceId", + "name": "userGroupId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -40247,131 +46838,66 @@ "200": { "content": { "application/json": { - "examples": { - "An example of a successful scan": { - "description": "An example of a successful scan", - "value": { - "schemaNames": [ - "demo", - "public" - ] - } - } - }, "schema": { - "$ref": "#/components/schemas/DataSourceSchemata" + "$ref": "#/components/schemas/UserManagementUserGroupMembers" } } }, - "description": "The result of the scan schemata" + "description": "OK" } }, - "summary": "Get a list of schema names of a database", "tags": [ - "Scanning", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "User management" + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/scanSql": { - "post": { - "description": "It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query", - "operationId": "scanSql", + "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions": { + "get": { + "operationId": "listPermissionsForUserGroup", "parameters": [ { - "description": "Data source id", - "example": "myPostgres", "in": "path", - "name": "dataSourceId", + "name": "userGroupId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScanSqlRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { - "examples": { - "An example of a successful scan": { - "description": "An example of a successful scan", - "value": { - "columns": [ - { - "dataType": "NUMERIC", - "name": "budget" - }, - { - "dataType": "STRING", - "name": "category" - }, - { - "dataType": "NUMERIC", - "name": "spend" - } - ], - "dataPreview": [ - [ - "1000", - "campaign1", - "458.8" - ], - [ - "1800", - "campaign2", - "144" - ] - ] - } - } - }, "schema": { - "$ref": "#/components/schemas/ScanSqlResponse" + "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, - "description": "The result of the scan." + "description": "OK" } }, - "summary": "Collect metadata about SQL query", "tags": [ - "Scanning", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/dataSources/{dataSourceId}/scanStatistics": { + "User management" + ] + }, "post": { - "description": "(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values.", - "operationId": "scanStatistics", + "operationId": "managePermissionsForUserGroup", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "userGroupId", "required": true, "schema": { "type": "string" @@ -40382,50 +46908,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TableStatisticsRequest" + "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TableStatisticsResponse" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(BETA) Collect physical table and column statistics from a StarRocks data source", "tags": [ - "Data Source - Statistics", - "actions" - ], - "x-gdc-security-info": { - "description": "Permission required to scan statistics.", - "permissions": [ - "USE" - ] - } + "User management" + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/test": { + "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers": { "post": { - "description": "Test if it is possible to connect to a database using an existing data source definition.", - "operationId": "testDataSource", + "operationId": "removeGroupMembers", "parameters": [ { - "description": "Data source id", - "example": "myPostgres", "in": "path", - "name": "dataSourceId", + "name": "userGroupId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -40434,97 +46942,162 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TestRequest" + "$ref": "#/components/schemas/UserManagementUserGroupMembers" } } }, "required": true }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/users": { + "get": { + "operationId": "listUsers", + "parameters": [ + { + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name. Note that user name is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter by workspaceId.", + "example": "workspace=demo", + "in": "query", + "name": "workspace", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter by userGroupId.", + "example": "group=admin", + "in": "query", + "name": "group", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter by dataSourceId.", + "example": "dataSource=demo-test-ds", + "in": "query", + "name": "dataSource", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], "responses": { "200": { "content": { "application/json": { - "examples": { - "An example of a successful connection": { - "description": "An example of a successful connection", - "value": { - "queryDurationMillis": { - "createCacheTable": 235, - "simpleSelect": 562 - }, - "successful": true - } - }, - "An example of an unsuccessful connection": { - "description": "An example of an unsuccessful connection", - "value": { - "error": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", - "successful": false - } - } - }, "schema": { - "$ref": "#/components/schemas/TestResponse" + "$ref": "#/components/schemas/UserManagementUsers" } } }, - "description": "The result of the test of a data source connection." + "description": "OK" } }, - "summary": "Test data source connection by data source id", "tags": [ - "Test Connection", - "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to test a data source.", - "permissions": [ - "USE" - ] - } + "User management" + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { - "post": { - "description": "Notification sets up all reports to be computed again with new data.", - "operationId": "registerUploadNotification", + "/api/v1/actions/userManagement/users/{userId}/permissions": { + "get": { + "operationId": "listPermissionsForUser", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "userId", "required": true, "schema": { "type": "string" } + }, + { + "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" } ], "responses": { - "204": { - "content": {}, - "description": "An upload notification has been successfully registered." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementPermissionAssignments" + } + } + }, + "description": "OK" } }, - "summary": "Register an upload notification", "tags": [ - "Invalidate Cache", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/deleteFiles": { + "User management" + ] + }, "post": { - "description": "Delete the files in the given data source.", - "operationId": "deleteFiles", + "operationId": "managePermissionsForUser", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "userId", "required": true, "schema": { "type": "string" @@ -40535,7 +47108,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeleteFilesRequest" + "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, @@ -40544,126 +47117,104 @@ "responses": { "204": { "content": {}, - "description": "Successful deletion." + "description": "No Content" } }, - "summary": "Delete datasource files", "tags": [ - "Data source files deletion", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "User management" + ] } }, - "/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.", - "operationId": "importCsv", + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { + "get": { + "description": "Returns a list of Users who created any object for this workspace", + "operationId": "createdBy", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportCsvRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ImportCsvResponse" - }, - "type": "array" + "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" } } }, - "description": "Successful import." + "description": "OK" } }, - "summary": "Import CSV", + "summary": "Get Analytics Catalog CreatedBy Users", "tags": [ - "Data source files import", + "Smart Functions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles": { + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription": { "post": { - "description": "List all the files in the given data source.", - "operationId": "listFiles", + "description": "Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.", + "operationId": "generateDescription", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "dataSourceId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateDescriptionRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/GdStorageFile" - }, - "type": "array" + "$ref": "#/components/schemas/GenerateDescriptionResponse" } } }, - "description": "Successful listing." + "description": "OK" } }, - "summary": "List datasource files", + "summary": "Generate Description for Analytics Object", "tags": [ - "Data source files listing", + "Smart Functions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests": { + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle": { "post": { - "description": "Read the manifests of the CSV files in the given data source.", - "operationId": "readCsvFileManifests", + "description": "Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed.", + "operationId": "generateTitle", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "dataSourceId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -40672,7 +47223,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ReadCsvFileManifestsRequest" + "$ref": "#/components/schemas/GenerateTitleRequest" } } }, @@ -40683,363 +47234,261 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ReadCsvFileManifestsResponse" - }, - "type": "array" + "$ref": "#/components/schemas/GenerateTitleResponse" } } }, - "description": "Successful listing." + "description": "OK" } }, - "summary": "Read CSV file manifests", + "summary": "Generate Title for Analytics Object", "tags": [ - "Data source files manifest read", + "Smart Functions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/fileStorage/staging/analyzeCsv": { - "post": { - "description": "Analyzes CSV files at the given locations", - "operationId": "analyzeCsv", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyzeCsvRequest" - } + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { + "get": { + "description": "Returns a list of tags for this workspace", + "operationId": "tags", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/AnalyzeCsvResponse" - }, - "type": "array" + "$ref": "#/components/schemas/AnalyticsCatalogTags" } } }, - "description": "Successful analysis." + "description": "OK" } }, - "summary": "Analyze CSV", + "summary": "Get Analytics Catalog Tags", "tags": [ - "Data source files analysis", + "Smart Functions", "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.", - "operationId": "stagingUpload", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "properties": { - "file": { - "description": "The file to upload.", - "format": "binary", - "type": "string" - } - }, - "required": [ - "file" - ], - "type": "object" - } + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects": { + "get": { + "description": "Returns a list of trending objects for this workspace", + "operationId": "trendingObjects", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" } } - }, + ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UploadFileResponse" + "$ref": "#/components/schemas/TrendingObjectsResult" } } }, - "description": "Upload was successful." + "description": "OK" } }, - "summary": "Upload a file to the staging area", + "summary": "Get Trending Analytics Catalog Objects", "tags": [ - "Data source staging location", + "Smart Functions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/ipAllowlistPolicies/{id}/addTargets": { + "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { "post": { - "operationId": "addTargets", + "deprecated": true, + "description": "Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead.", + "operationId": "aiChat", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "id", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IpAllowlistPolicyTargets" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "410": { + "description": "Gone" } }, - "summary": "Add targets to IP allowlist policy", + "summary": "(REMOVED) Chat with AI", "tags": [ - "Organization - Entity APIs", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/ipAllowlistPolicies/{id}/removeTargets": { + "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { "post": { - "operationId": "removeTargets", + "deprecated": true, + "description": "Removed. Chat history is served by the AI Assistant API.", + "operationId": "aiChatHistory", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "id", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IpAllowlistPolicyTargets" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "410": { + "description": "Gone" } }, - "summary": "Remove targets from IP allowlist policy", + "summary": "(REMOVED) Get Chat History", "tags": [ - "Organization - Entity APIs", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/notificationChannels/test": { + "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { "post": { - "description": "Tests the notification channel by sending a test notification.", - "operationId": "testNotificationChannel", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestDestinationRequest" - } + "deprecated": true, + "description": "Removed. Use POST /api/v1/ai/workspaces/{workspaceId}/chat (AI Assistant) instead.", + "operationId": "aiChatStream", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" } - }, - "required": true - }, + } + ], "responses": { - "200": { - "content": { - "application/json": { - "examples": { - "An example of a successful connection": { - "description": "An example of a successful connection", - "value": { - "successful": true - } - }, - "An example of an unsuccessful connection": { - "description": "An example of an unsuccessful connection", - "value": { - "error": "Authentication failed", - "successful": false - } - } - }, - "schema": { - "$ref": "#/components/schemas/TestResponse" - } - } - }, - "description": "The result of the test of a notification channel connection." + "410": { + "description": "Gone" } }, - "summary": "Test notification channel.", + "summary": "(REMOVED) Chat with AI", "tags": [ - "Notification Channels", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/notificationChannels/{notificationChannelId}/test": { - "post": { - "description": "Tests the existing notification channel by sending a test notification.", - "operationId": "testExistingNotificationChannel", + "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { + "get": { + "deprecated": true, + "description": "Removed. Chat usage is served by the AI Assistant API.", + "operationId": "aiChatUsage", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "notificationChannelId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TestDestinationRequest" - } - } + "responses": { + "410": { + "description": "Gone" } }, + "summary": "(REMOVED) Get Chat Usage", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/issues": { + "get": { + "description": "Returns metadata quality issues detected by the platform linter.", + "operationId": "getQualityIssues", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { - "examples": { - "An example of a successful connection": { - "description": "An example of a successful connection", - "value": { - "successful": true - } - }, - "An example of an unsuccessful connection": { - "description": "An example of an unsuccessful connection", - "value": { - "error": "Authentication failed", - "successful": false - } - } - }, "schema": { - "$ref": "#/components/schemas/TestResponse" + "$ref": "#/components/schemas/GetQualityIssuesResponse" } } }, - "description": "The result of the test of a notification channel connection." + "description": "OK" } }, - "summary": "Test existing notification channel.", + "summary": "Get Quality Issues", "tags": [ - "Notification Channels", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/notifications": { + "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}": { "get": { - "description": "Get latest in-platform notifications for the current user.", - "operationId": "getNotifications", + "description": "Returns the status of a quality issues calculation process identified by process ID.", + "operationId": "getQualityIssuesCalculationStatus", "parameters": [ { - "description": "Workspace ID to filter notifications by.", - "in": "query", + "description": "Workspace identifier", + "in": "path", "name": "workspaceId", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter notifications by read status.", - "in": "query", - "name": "isRead", - "required": false, - "schema": { - "type": "boolean" - }, - "style": "form" - }, - { - "description": "Zero-based page index (0..N)", - "in": "query", - "name": "page", - "required": false, + "required": true, "schema": { - "default": "0", - "minimum": 0, + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" - }, - "style": "form" + } }, { - "description": "The size of the page to be returned.", - "in": "query", - "name": "size", - "required": false, + "in": "path", + "name": "processId", + "required": true, "schema": { - "default": "20", - "minimum": 1, "type": "string" - }, - "style": "form" - }, - { - "description": "Additional meta information to include in the response.", - "explode": true, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "items": { - "enum": [ - "total", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + } } ], "responses": { @@ -41047,206 +47496,252 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Notifications" + "$ref": "#/components/schemas/QualityIssuesCalculationStatusResponse" } } }, "description": "OK" } }, - "summary": "Get latest notifications.", + "summary": "Get Quality Issues Calculation Status", "tags": [ - "Notification Channels", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/notifications/markAsRead": { + "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck": { "post": { - "description": "Mark all user in-platform notifications as read.", - "operationId": "markAsReadNotificationAll", + "description": "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", + "operationId": "triggerQualityIssuesCalculation", "parameters": [ { - "description": "Workspace ID where to mark notifications as read.", - "in": "query", + "description": "Workspace identifier", + "in": "path", "name": "workspaceId", - "required": false, + "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" - }, - "style": "form" + } } ], "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TriggerQualityIssuesCalculationResponse" + } + } + }, + "description": "OK" } }, - "summary": "Mark all notifications as read.", + "summary": "Trigger Quality Issues Calculation", "tags": [ - "Notification Channels", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/notifications/{notificationId}/markAsRead": { - "post": { - "description": "Mark in-platform notification by its ID as read.", - "operationId": "markAsReadNotification", + "/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy": { + "get": { + "description": "Returns a list of Users who created any memory item for this workspace", + "operationId": "memoryCreatedByUsers", "parameters": [ { - "description": "Notification ID to mark as read.", + "description": "Workspace identifier", "in": "path", - "name": "notificationId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Mark notification as read.", - "tags": [ - "Notification Channels", - "actions" - ] - } - }, - "/api/v1/actions/organization/automations/delete": { - "post": { - "operationId": "deleteOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MemoryItemCreatedByUsers" + } } - } - }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" + }, + "description": "OK" } }, - "summary": "Delete selected automations across all workspaces", + "summary": "Get AI Memory CreatedBy Users", "tags": [ - "Automations", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/organization/automations/pause": { - "post": { - "operationId": "pauseOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" - } + "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints": { + "get": { + "deprecated": true, + "description": "Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders instead. Always returns 410 Gone.", + "operationId": "resolveLlmEndpoints", + "parameters": [ + { + "description": "Workspace identifier", + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" } - }, - "required": true - }, + } + ], "responses": { - "204": { + "410": { "content": {}, - "description": "No Content" + "description": "Gone" } }, - "summary": "Pause selected automations across all workspaces", + "summary": "Get Active LLM Endpoints for this workspace (Removed)", "tags": [ - "Automations", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/organization/automations/unpause": { - "post": { - "operationId": "unpauseOrganizationAutomations", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" - } + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { + "get": { + "operationId": "availableAssignees", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } }, - "required": true - }, + { + "in": "path", + "name": "dashboardId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AvailableAssignees" + } + } + }, + "description": "OK" } }, - "summary": "Unpause selected automations across all workspaces", + "summary": "Get Available Assignees", "tags": [ - "Automations", + "Permissions", "actions" ] } }, - "/api/v1/actions/organization/automations/unsubscribe": { - "delete": { - "operationId": "unsubscribeAllAutomations", - "responses": { - "204": { - "content": {}, - "description": "No Content" + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular": { + "post": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular 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": "createDashboardExportRequest", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "dashboardId", + "required": true, + "schema": { + "type": "string" + } } - }, - "summary": "Unsubscribe from all automations in all workspaces", - "tags": [ - "Automations", - "actions" - ] - }, - "post": { - "operationId": "unsubscribeOrganizationAutomations", + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "$ref": "#/components/schemas/DashboardTabularExportRequest" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExportResponse" + } + } + }, + "description": "Tabular export request created successfully." } }, - "summary": "Unsubscribe from selected automations across all workspaces", + "summary": "(EXPERIMENTAL) Create dashboard tabular export request", "tags": [ - "Automations", + "Tabular export", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to execute tabular export.", + "permissions": [ + "EXPORT_TABULAR" + ] + } } }, - "/api/v1/actions/organization/managePermissions": { + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions": { "post": { - "description": "Manage Permissions for a Organization", - "operationId": "manageOrganizationPermissions", + "operationId": "manageDashboardPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "dashboardId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "An array of organization permissions assignments", + "description": "An array of dashboard permissions assignments", "items": { - "$ref": "#/components/schemas/OrganizationPermissionAssignment" + "oneOf": [ + { + "$ref": "#/components/schemas/PermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/PermissionsForAssigneeRule" + } + ] }, "type": "array" } @@ -41260,45 +47755,90 @@ "description": "No Content" } }, - "summary": "Manage Permissions for a Organization", + "summary": "Manage Permissions for a Dashboard", "tags": [ "Permissions", "actions" ] } }, - "/api/v1/actions/organization/reloadObservabilityLayout": { - "post": { - "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", - "operationId": "reloadObservabilityLayout", + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions": { + "get": { + "operationId": "dashboardPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "dashboardId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DashboardPermissions" + } + } + }, + "description": "OK" } }, - "summary": "Reload the managed AI observability layout", + "summary": "Get Dashboard Permissions", "tags": [ - "AI Observability", + "Permissions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/organization/switchActiveIdentityProvider": { + "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions": { "post": { - "description": "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", - "operationId": "switchActiveIdentityProvider", + "operationId": "manageAttributePermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "attributeId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwitchIdentityProviderRequest" + "description": "An array of attribute-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AttributePermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/AttributePermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, @@ -41310,134 +47850,136 @@ "description": "No Content" } }, - "summary": "Switch Active Identity Provider", + "summary": "Manage Permissions for an Attribute", "tags": [ - "Identity Providers", + "Permissions", "actions" ] } }, - "/api/v1/actions/resolveEntitlements": { + "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions": { "get": { - "description": "Resolves values of available entitlements for the organization.", - "operationId": "resolveAllEntitlements", + "operationId": "attributePermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "attributeId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ApiEntitlement" - }, - "type": "array" + "$ref": "#/components/schemas/AttributePermissions" } } }, "description": "OK" } }, - "summary": "Values for all public entitlements.", + "summary": "Get Attribute Permissions", "tags": [ - "Entitlement", + "Permissions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } - }, + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { "post": { - "description": "Resolves values for requested entitlements in the organization.", - "operationId": "resolveRequestedEntitlements", + "operationId": "deleteWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EntitlementsRequest" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ApiEntitlement" - }, - "type": "array" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "Values for requested public entitlements.", + "summary": "Delete selected automations in the workspace", "tags": [ - "Entitlement", + "Automations", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } + ] } }, - "/api/v1/actions/resolveSettings": { - "get": { - "description": "Resolves values for all settings without workspace by current user, organization, or default settings.", - "operationId": "resolveAllSettingsWithoutWorkspace", + "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { + "post": { + "operationId": "pauseWorkspaceAutomations", "parameters": [ { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } - }, - "description": "Values for selected settings." + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "Values for all settings without workspace.", + "summary": "Pause selected automations in the workspace", "tags": [ - "Reporting - Settings", + "Automations", "actions" ] - }, + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/trigger": { "post": { - "description": "Resolves values for selected settings without workspace by current user, organization, or default settings.", - "operationId": "resolveSettingsWithoutWorkspace", + "description": "Trigger the automation in the request.", + "operationId": "triggerAutomation", "parameters": [ { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], @@ -41445,197 +47987,259 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResolveSettingsRequest" + "$ref": "#/components/schemas/TriggerAutomationRequest" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" - } - } - }, - "description": "Values for selected settings." + "204": { + "description": "The automation is successfully triggered." } }, - "summary": "Values for selected settings without workspace.", + "summary": "Trigger automation.", "tags": [ - "Reporting - Settings", + "Automations", "actions" ] } }, - "/api/v1/actions/userManagement/assignPermissions": { + "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { "post": { - "operationId": "assignPermissions", + "operationId": "unpauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PermissionsAssignment" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { - "200": { + "204": { "content": {}, - "description": "OK" + "description": "No Content" } }, + "summary": "Unpause selected automations in the workspace", "tags": [ - "User management" + "Automations", + "actions" ] } }, - "/api/v1/actions/userManagement/removeUsersUserGroups": { - "post": { - "operationId": "removeUsersUserGroups", - "requestBody": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "type": "array" - } + "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { + "delete": { + "operationId": "unsubscribeWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { - "200": { + "204": { "content": {}, - "description": "OK" + "description": "No Content" } }, + "summary": "Unsubscribe from all automations in the workspace", "tags": [ - "User management" + "Automations", + "actions" ] - } - }, - "/api/v1/actions/userManagement/revokePermissions": { + }, "post": { - "operationId": "revokePermissions", + "operationId": "unsubscribeSelectedWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PermissionsAssignment" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { - "200": { + "204": { "content": {}, - "description": "OK" + "description": "No Content" } }, + "summary": "Unsubscribe from selected automations in the workspace", "tags": [ - "User management" + "Automations", + "actions" ] } }, - "/api/v1/actions/userManagement/userGroups": { - "get": { - "operationId": "listUserGroups", + "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger": { + "post": { + "description": "Trigger the existing automation to execute immediately.", + "operationId": "triggerExistingAutomation", "parameters": [ { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" + "type": "string" + } }, { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, + "in": "path", + "name": "automationId", + "required": true, "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The automation is successfully triggered." + } + }, + "summary": "Trigger existing automation.", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { + "delete": { + "operationId": "unsubscribeAutomation", + "parameters": [ { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { "type": "string" - }, - "style": "form" + } }, { - "description": "Filter by workspaceId.", - "example": "workspace=demo", - "in": "query", - "name": "workspace", - "required": false, + "in": "path", + "name": "automationId", + "required": true, "schema": { "type": "string" - }, - "style": "form" - }, + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unsubscribe from an automation", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides": { + "post": { + "description": "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", + "operationId": "checkEntityOverrides", + "parameters": [ { - "description": "Filter by dataSourceId.", - "example": "dataSource=demo-test-ds", - "in": "query", - "name": "dataSource", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { "type": "string" - }, - "style": "form" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of object identifications", + "items": { + "$ref": "#/components/schemas/HierarchyObjectIdentification" + }, + "type": "array" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroups" + "items": { + "$ref": "#/components/schemas/IdentifierDuplications" + }, + "type": "array" } } }, - "description": "OK" + "description": "Searching for entities finished successfully." } }, + "summary": "Finds entities with given ID in hierarchy.", "tags": [ - "User management" - ] + "Hierarchy", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers": { + "/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions": { "post": { - "operationId": "addGroupMembers", + "operationId": "manageComputedAttributePermissions", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "computedAttributeId", "required": true, "schema": { "type": "string" @@ -41646,7 +48250,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" + "description": "An array of computed-attribute-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/ComputedAttributePermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/ComputedAttributePermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, @@ -41658,18 +48273,28 @@ "description": "No Content" } }, + "summary": "(BETA) Manage Permissions for a Computed Attribute", "tags": [ - "User management" + "Permissions", + "actions" ] } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/members": { + "/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions": { "get": { - "operationId": "getGroupMembers", + "operationId": "computedAttributePermissions", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "computedAttributeId", "required": true, "schema": { "type": "string" @@ -41681,41 +48306,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" + "$ref": "#/components/schemas/ComputedAttributePermissions" } } }, "description": "OK" } }, + "summary": "(BETA) Get Computed Attribute Permissions", "tags": [ - "User management" + "Permissions", + "actions" ] } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions": { + "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph": { "get": { - "operationId": "listPermissionsForUserGroup", + "description": "Computes the dependent entities graph", + "operationId": "getDependentEntitiesGraph", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } - }, - { - "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", - "example": "includeInherited=true", - "in": "query", - "name": "includeInherited", - "required": false, - "schema": { - "default": false, - "type": "boolean" - }, - "style": "form" } ], "responses": { @@ -41723,23 +48339,32 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/DependentEntitiesResponse" } } }, - "description": "OK" + "description": "Computes the dependent entities graph" } }, + "summary": "Computes the dependent entities graph", "tags": [ - "User management" - ] + "Dependency Graph", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to read the graph.", + "permissions": [ + "VIEW" + ] + } }, "post": { - "operationId": "managePermissionsForUserGroup", + "description": "Computes the dependent entities graph from given entry points", + "operationId": "getDependentEntitiesGraphFromEntryPoints", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { "type": "string" @@ -41750,32 +48375,49 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/DependentEntitiesRequest" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DependentEntitiesResponse" + } + } + }, + "description": "Computes the dependent entities graph from given entry points" } }, + "summary": "Computes the dependent entities graph from given entry points", "tags": [ - "User management" - ] + "Dependency Graph", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to read the graph.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { "post": { - "operationId": "removeGroupMembers", + "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", + "operationId": "cancelExecutions", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -41784,164 +48426,100 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" + "$ref": "#/components/schemas/AfmCancelTokens" } } }, "required": true }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/users": { - "get": { - "operationId": "listUsers", - "parameters": [ - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by workspaceId.", - "example": "workspace=demo", - "in": "query", - "name": "workspace", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by userGroupId.", - "example": "group=admin", - "in": "query", - "name": "group", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by dataSourceId.", - "example": "dataSource=demo-test-ds", - "in": "query", - "name": "dataSource", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - } - ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUsers" + "$ref": "#/components/schemas/AfmCancelTokens" } } }, - "description": "OK" + "description": "Status of the cancellation operation." } }, + "summary": "Applies all the given cancel tokens.", "tags": [ - "User management" - ] + "Computation", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/userManagement/users/{userId}/permissions": { - "get": { - "operationId": "listPermissionsForUser", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { + "post": { + "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", + "operationId": "computeValidDescendants", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, - { - "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", - "example": "includeInherited=true", - "in": "query", - "name": "includeInherited", - "required": false, - "schema": { - "default": false, - "type": "boolean" - }, - "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmValidDescendantsQuery" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/AfmValidDescendantsResponse" } } }, - "description": "OK" + "description": "Map of lists of attributes valid as descendants of the given attributes." } }, + "summary": "(BETA) Valid descendants", "tags": [ - "User management" - ] - }, + "Computation", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to analyze data.", + "permissions": [ + "ANALYZE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects": { "post": { - "operationId": "managePermissionsForUser", + "description": "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", + "operationId": "computeValidObjects", "parameters": [ { + "description": "Workspace identifier", "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -41950,60 +48528,123 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/AfmValidObjectsQuery" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmValidObjectsResponse" + } + } + }, + "description": "List of attributes, facts and metrics valid with respect to given AFM." } }, + "summary": "Valid objects", "tags": [ - "User management" - ] + "Computation", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to view data.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { - "get": { - "description": "Returns a list of Users who created any object for this workspace", - "operationId": "createdBy", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute": { + "post": { + "description": "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", + "operationId": "computeReport", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "deprecated": true, + "example": "2020-06-03T10:15:30+01:00", + "in": "header", + "name": "timestamp", + "required": false, + "schema": { + "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", + "format": "timestamp", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AfmExecution" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" + "$ref": "#/components/schemas/AfmExecutionResponse" } } }, - "description": "OK" + "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "A token that can be used to cancel this execution", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, - "summary": "Get Analytics Catalog CreatedBy Users", + "summary": "Executes analytical request and returns link to the result", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription": { - "post": { - "description": "Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.", - "operationId": "generateDescription", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { + "get": { + "description": "Gets a single execution result.", + "operationId": "retrieveResult", "parameters": [ { "description": "Workspace identifier", @@ -42014,41 +48655,105 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateDescriptionRequest" - } + }, + { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in": "path", + "name": "resultId", + "required": true, + "schema": { + "type": "string" } }, - "required": true - }, + { + "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", + "example": "offset=1,10", + "explode": false, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": [], + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", + "example": "limit=1,10", + "explode": false, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": [], + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.", + "example": "excludedTotalDimensions=dim_0,dim_1", + "explode": false, + "in": "query", + "name": "excludedTotalDimensions", + "required": false, + "schema": { + "default": [], + "items": { + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GenerateDescriptionResponse" + "$ref": "#/components/schemas/ExecutionResult" } } }, - "description": "OK" + "description": "Execution result was found and returned." } }, - "summary": "Generate Description for Analytics Object", + "summary": "Get a single execution result", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle": { - "post": { - "description": "Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed.", - "operationId": "generateTitle", + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary": { + "get": { + "description": "(BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.", + "operationId": "retrieveResultBinary", "parameters": [ { "description": "Workspace identifier", @@ -42059,74 +48764,72 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateTitleRequest" - } - } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateTitleResponse" - } - } - }, - "description": "OK" - } - }, - "summary": "Generate Title for Analytics Object", - "tags": [ - "Smart Functions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { - "get": { - "description": "Returns a list of tags for this workspace", - "operationId": "tags", - "parameters": [ { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "workspaceId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-GDC-CANCEL-TOKEN", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { "200": { "content": { - "application/json": { + "application/vnd.apache.arrow.file": { "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogTags" + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { + "schema": { + "format": "binary", + "type": "string" } } }, - "description": "OK" + "description": "Execution result was found and returned.", + "headers": { + "X-GDC-RESULT-TOTAL-ROWS": { + "description": "Total number of data rows in the full result.", + "schema": { + "format": "int64", + "type": "integer" + }, + "style": "simple" + } + } } }, - "summary": "Get Analytics Catalog Tags", + "summary": "(BETA) Get a single execution result in Apache Arrow File or Stream format", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": { "get": { - "description": "Returns a list of trending objects for this workspace", - "operationId": "trendingObjects", + "description": "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", + "operationId": "retrieveExecutionMetadata", "parameters": [ { "description": "Workspace identifier", @@ -42137,6 +48840,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in": "path", + "name": "resultId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -42144,24 +48857,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TrendingObjectsResult" + "$ref": "#/components/schemas/ResultCacheMetadata" } } }, - "description": "OK" + "description": "Execution result's metadata was found and returned." } }, - "summary": "Get Trending Analytics Catalog Objects", + "summary": "Get a single execution result's metadata.", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to analyze data.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { + "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain": { "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", - "operationId": "aiChat", + "description": "The resource provides static structures needed for investigation of a problem with given AFM.", + "operationId": "explainAFM", "parameters": [ { "description": "Workspace identifier", @@ -42172,13 +48891,37 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request\n\n`GIT` - Git properties of current build", + "in": "query", + "name": "explainType", + "required": false, + "schema": { + "enum": [ + "MAQL", + "GRPC_MODEL", + "GRPC_MODEL_SVG", + "WDF", + "QT", + "QT_SVG", + "OPT_QT", + "OPT_QT_SVG", + "SQL", + "SETTINGS", + "COMPRESSED_SQL", + "COMPRESSED_GRPC_MODEL_SVG", + "GIT" + ], + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatRequest" + "$ref": "#/components/schemas/AfmExecution" } } }, @@ -42187,26 +48930,37 @@ "responses": { "200": { "content": { - "application/json": { + "application/json": {}, + "application/sql": {}, + "application/zip": { "schema": { - "$ref": "#/components/schemas/ChatResult" + "description": "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", + "format": "binary", + "type": "string" } - } + }, + "image/svg+xml": {} }, - "description": "OK" + "description": "Requested resource" } }, - "summary": "(BETA) Chat with AI", + "summary": "AFM explain resource.", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to analyze data.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { + "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": { "post": { - "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", - "operationId": "aiChatHistory", + "description": "Returns paged list of elements (values) of given label satisfying given filtering criteria.", + "operationId": "computeLabelElementsPost", "parameters": [ { "description": "Workspace identifier", @@ -42217,13 +48971,49 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "in": "query", + "name": "offset", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "maximum": 10000, + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "default": 1000, + "format": "int32", + "maximum": 10000, + "minimum": 1, + "type": "integer" + } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatHistoryRequest" + "$ref": "#/components/schemas/ElementsRequest" } } }, @@ -42234,24 +49024,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatHistoryResult" + "$ref": "#/components/schemas/ElementsResponse" } } }, - "description": "OK" + "description": "List of label values." } }, - "summary": "(BETA) Get Chat History", + "summary": "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", "tags": [ - "Smart Functions", + "Computation", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to view a report or label elements.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { + "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis": { "post": { - "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", - "operationId": "aiChatStream", + "description": "Computes change analysis for the provided execution definition.", + "operationId": "changeAnalysis", "parameters": [ { "description": "Workspace identifier", @@ -42268,7 +49064,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatRequest" + "$ref": "#/components/schemas/ChangeAnalysisRequest" } } }, @@ -42277,29 +49073,26 @@ "responses": { "200": { "content": { - "text/event-stream": { + "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ServerSentEventChatResult" - }, - "type": "array" + "$ref": "#/components/schemas/ChangeAnalysisResponse" } } }, "description": "OK" } }, - "summary": "(BETA) Chat with AI", + "summary": "Compute change analysis", "tags": [ - "Smart Functions", + "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { + "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}": { "get": { - "description": "Returns usage statistics of chat for a user in a workspace.", - "operationId": "aiChatUsage", + "description": "Gets change analysis result.", + "operationId": "changeAnalysisResult", "parameters": [ { "description": "Workspace identifier", @@ -42310,6 +49103,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", + "in": "path", + "name": "resultId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -42317,24 +49120,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChatUsageResponse" + "$ref": "#/components/schemas/ChangeAnalysisResult" } } }, "description": "OK" } }, - "summary": "Get Chat Usage", + "summary": "Get change analysis result", "tags": [ - "Smart Functions", + "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues": { - "get": { - "description": "Returns metadata quality issues detected by the platform linter.", - "operationId": "getQualityIssues", + "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { + "post": { + "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", + "operationId": "keyDriverAnalysis", "parameters": [ { "description": "Workspace identifier", @@ -42345,31 +49148,51 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeyDriversRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/GetQualityIssuesResponse" + "$ref": "#/components/schemas/KeyDriversResponse" } } }, "description": "OK" } }, - "summary": "Get Quality Issues", + "summary": "(EXPERIMENTAL) Compute key driver analysis", "tags": [ - "Smart Functions", + "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}": { + "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { "get": { - "description": "Returns the status of a quality issues calculation process identified by process ID.", - "operationId": "getQualityIssuesCalculationStatus", + "description": "(EXPERIMENTAL) Gets key driver analysis.", + "operationId": "keyDriverAnalysisResult", "parameters": [ { "description": "Workspace identifier", @@ -42382,12 +49205,32 @@ } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "processId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "in": "query", + "name": "offset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } } ], "responses": { @@ -42395,24 +49238,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QualityIssuesCalculationStatusResponse" + "$ref": "#/components/schemas/KeyDriversResult" } } }, "description": "OK" } }, - "summary": "Get Quality Issues Calculation Status", + "summary": "(EXPERIMENTAL) Get key driver analysis result", "tags": [ - "Smart Functions", + "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck": { + "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers": { "post": { - "description": "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", - "operationId": "triggerQualityIssuesCalculation", + "description": "(BETA) Computes outlier detection for the provided execution definition.", + "operationId": "outlierDetection", "parameters": [ { "description": "Workspace identifier", @@ -42423,67 +49266,51 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TriggerQualityIssuesCalculationResponse" - } - } - }, - "description": "OK" - } - }, - "summary": "Trigger Quality Issues Calculation", - "tags": [ - "Smart Functions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy": { - "get": { - "description": "Returns a list of Users who created any memory item for this workspace", - "operationId": "memoryCreatedByUsers", - "parameters": [ + }, { - "description": "Workspace identifier", - "in": "path", - "name": "workspaceId", - "required": true, + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "default": false, + "type": "boolean" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OutlierDetectionRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MemoryItemCreatedByUsers" + "$ref": "#/components/schemas/OutlierDetectionResponse" } } }, "description": "OK" } }, - "summary": "Get AI Memory CreatedBy Users", + "summary": "(BETA) Outlier Detection", "tags": [ - "Smart Functions", + "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints": { + "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}": { "get": { - "deprecated": true, - "description": "Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders instead. Always returns 410 Gone.", - "operationId": "resolveLlmEndpoints", + "description": "(BETA) Gets outlier detection result.", + "operationId": "outlierDetectionResult", "parameters": [ { "description": "Workspace identifier", @@ -42494,35 +49321,34 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - } - ], - "responses": { - "410": { - "content": {}, - "description": "Gone" - } - }, - "summary": "Get Active LLM Endpoints for this workspace (Removed)", - "tags": [ - "Smart Functions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders": { - "get": { - "description": "Resolves the active LLM provider configuration for the given workspace.", - "operationId": "resolveLlmProviders", - "parameters": [ + }, { - "description": "Workspace identifier", + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "workspaceId", + "name": "resultId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } + }, + { + "in": "query", + "name": "offset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } } ], "responses": { @@ -42530,24 +49356,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResolvedLlms" + "$ref": "#/components/schemas/OutlierDetectionResult" } } }, "description": "OK" } }, - "summary": "Get Active LLM configuration for this workspace", + "summary": "(BETA) Outlier Detection Result", "tags": [ - "Smart Functions", + "Computation", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/search": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow": { "post": { - "description": "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.", - "operationId": "aiSearch", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Runs the transformations of a flow over its inputs and stores the result. The response links to the result.", + "operationId": "executeFlow", "parameters": [ { "description": "Workspace identifier", @@ -42564,7 +49390,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchRequest" + "$ref": "#/components/schemas/FlowRequest" } } }, @@ -42575,23 +49401,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchResult" + "$ref": "#/components/schemas/FlowExecutionResponse" } } }, - "description": "OK" + "description": "The flow was accepted.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "Token that cancels the flow when it is given to the cancel endpoint.", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, - "summary": "(BETA) Semantic Search in Metadata", + "summary": "(EXPERIMENTAL) Execute a flow", "tags": [ - "Smart Functions", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to run a flow.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/workflow/dashboardSummary": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/cancel": { "post": { - "operationId": "generateDashboardSummary", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Each result has one cancel token, which the submit of its flow returns. Applying the token cancels the flow that computes the result.", + "operationId": "cancelFlows", "parameters": [ { "description": "Workspace identifier", @@ -42608,7 +49450,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkflowDashboardSummaryRequestDto" + "$ref": "#/components/schemas/AfmCancelTokens" } } }, @@ -42619,21 +49461,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkflowDashboardSummaryResponseDto" + "$ref": "#/components/schemas/AfmCancelTokens" } } }, "description": "OK" } }, + "summary": "(EXPERIMENTAL) Apply the given cancel tokens to flows", "tags": [ - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to cancel a flow.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/cancel": { - "post": { - "operationId": "cancelWorkflow", + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/operations": { + "get": { + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Lists the operations that the transformations of a flow can run, with their inputs and the JSON Schema of their parameters.", + "operationId": "listFlowOperations", "parameters": [ { "description": "Workspace identifier", @@ -42644,14 +49495,6 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, - { - "in": "path", - "name": "runId", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { @@ -42659,24 +49502,30 @@ "content": { "application/json": { "schema": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "$ref": "#/components/schemas/FlowOperations" } } }, "description": "OK" } }, + "summary": "(EXPERIMENTAL) List the operations of flows", "tags": [ - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to list the operations of flows.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/workflow/{runId}/status": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/binary": { "get": { - "operationId": "getWorkflowStatus", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result as an Apache Arrow IPC File or Stream.", + "operationId": "retrieveFlowResultBinary", "parameters": [ { "description": "Workspace identifier", @@ -42689,46 +49538,108 @@ } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "runId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "description": "Index of the first row to return. The default is 0.", + "in": "query", + "name": "rowOffset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Maximum number of rows to return. The default is all remaining rows.", + "in": "query", + "name": "rowLimit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Index of the first column to return. The default is 0.", + "in": "query", + "name": "columnOffset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Maximum number of columns to return. The default is all remaining columns.", + "in": "query", + "name": "columnLimit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } } ], "responses": { "200": { "content": { - "application/json": { + "application/vnd.apache.arrow.file": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { "schema": { - "$ref": "#/components/schemas/WorkflowStatusResponseDto" + "format": "binary", + "type": "string" } } }, - "description": "OK" + "description": "The result." } }, + "summary": "(EXPERIMENTAL) Get a flow result in Apache Arrow File or Stream format", "tags": [ - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to read a flow result.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/metadata": { "get": { - "operationId": "availableAssignees", + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Gets the columns and the number of rows of a flow result.", + "operationId": "retrieveFlowResultMetadata", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "dashboardId", + "name": "resultId", "required": true, "schema": { "type": "string" @@ -42740,150 +49651,159 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AvailableAssignees" + "$ref": "#/components/schemas/FlowResultMetadata" } } }, "description": "OK" } }, - "summary": "Get Available Assignees", + "summary": "(EXPERIMENTAL) Get the metadata of a flow result", "tags": [ - "Permissions", - "actions" - ] + "actions", + "Flow" + ], + "x-gdc-security-info": { + "description": "Permissions required to read a flow result.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular": { - "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular 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": "createDashboardExportRequest", + "/api/v1/actions/workspaces/{workspaceId}/execution/flow/result/{resultId}/table": { + "get": { + "description": "Note: This API is experimental and is going to change. Please, use it accordingly. Gets a window of rows and columns of a flow result.", + "operationId": "retrieveFlowResultTable", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "dashboardId", + "name": "resultId", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DashboardTabularExportRequest" - } + }, + { + "description": "Index of the first row to return. The default is 0.", + "in": "query", + "name": "rowOffset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" } }, - "required": true - }, + { + "description": "Maximum number of rows to return. The default is all remaining rows.", + "in": "query", + "name": "rowLimit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Index of the first column to return. The default is 0.", + "in": "query", + "name": "columnOffset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "description": "Maximum number of columns to return. The default is all remaining columns.", + "in": "query", + "name": "columnLimit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExportResponse" + "$ref": "#/components/schemas/FlowTableResult" } } }, - "description": "Tabular export request created successfully." + "description": "OK" } }, - "summary": "(EXPERIMENTAL) Create dashboard tabular export request", + "summary": "(EXPERIMENTAL) Get a page of a flow result", "tags": [ - "Tabular export", - "actions" + "actions", + "Flow" ], "x-gdc-security-info": { - "description": "Permissions required to execute tabular export.", + "description": "Permissions required to read a flow result.", "permissions": [ - "EXPORT_TABULAR" + "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions": { - "post": { - "operationId": "manageDashboardPermissions", + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}": { + "get": { + "deprecated": true, + "description": "(EXPERIMENTAL) Gets anomalies.", + "operationId": "anomalyDetectionResult", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "dashboardId", + "name": "resultId", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of dashboard permissions assignments", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/PermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/PermissionsForAssigneeRule" - } - ] - }, - "type": "array" - } - } }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Manage Permissions for a Dashboard", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions": { - "get": { - "operationId": "dashboardPermissions", - "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "in": "query", + "name": "offset", + "required": false, "schema": { - "type": "string" + "format": "int32", + "type": "integer" } }, { - "in": "path", - "name": "dashboardId", - "required": true, + "in": "query", + "name": "limit", + "required": false, "schema": { - "type": "string" + "format": "int32", + "type": "integer" } } ], @@ -42892,94 +49812,128 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DashboardPermissions" + "$ref": "#/components/schemas/AnomalyDetectionResult" } } }, "description": "OK" } }, - "summary": "Get Dashboard Permissions", + "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection Result", "tags": [ - "Permissions", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions": { + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}": { "post": { - "operationId": "manageAttributePermissions", + "deprecated": true, + "description": "(EXPERIMENTAL) Computes anomaly detection.", + "operationId": "anomalyDetection", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { + "description": "Input result ID to be used in the computation", + "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", - "name": "attributeId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "An array of attribute-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributePermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/AttributePermissionsForAssigneeRule" - } - ] - }, - "type": "array" + "$ref": "#/components/schemas/AnomalyDetectionRequest" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartFunctionResponse" + } + } + }, + "description": "OK" } }, - "summary": "Manage Permissions for an Attribute", + "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection", "tags": [ - "Permissions", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions": { + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}": { "get": { - "operationId": "attributePermissions", + "description": "(EXPERIMENTAL) Gets clustering result.", + "operationId": "clusteringResult", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "attributeId", + "name": "resultId", "required": true, "schema": { "type": "string" } + }, + { + "in": "query", + "name": "offset", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } + }, + { + "in": "query", + "name": "limit", + "required": false, + "schema": { + "format": "int32", + "type": "integer" + } } ], "responses": { @@ -42987,103 +49941,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AttributePermissions" + "$ref": "#/components/schemas/ClusteringResult" } } }, "description": "OK" } }, - "summary": "Get Attribute Permissions", + "summary": "(EXPERIMENTAL) Smart functions - Clustering Result", "tags": [ - "Permissions", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}": { "post": { - "operationId": "deleteWorkspaceAutomations", + "description": "(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.", + "operationId": "clustering", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Delete selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { - "post": { - "operationId": "pauseWorkspaceAutomations", - "parameters": [ { + "description": "Input result ID to be used in the computation", + "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", - "name": "workspaceId", + "name": "resultId", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Pause selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/trigger": { - "post": { - "description": "Trigger the automation in the request.", - "operationId": "triggerAutomation", - "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } } ], @@ -43091,199 +49995,127 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TriggerAutomationRequest" + "$ref": "#/components/schemas/ClusteringRequest" } } }, "required": true }, "responses": { - "204": { - "description": "The automation is successfully triggered." - } - }, - "summary": "Trigger automation.", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { - "post": { - "operationId": "unpauseWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartFunctionResponse" + } } - } - }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" + }, + "description": "OK" } }, - "summary": "Unpause selected automations in the workspace", + "summary": "(EXPERIMENTAL) Smart functions - Clustering", "tags": [ - "Automations", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { - "delete": { - "operationId": "unsubscribeWorkspaceAutomations", + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": { + "get": { + "description": "Gets forecast result.", + "operationId": "forecastResult", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - } - ], - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Unsubscribe from all automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - }, - "post": { - "operationId": "unsubscribeSelectedWorkspaceAutomations", - "parameters": [ + }, { + "description": "Result ID", + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "workspaceId", + "name": "resultId", "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Unsubscribe from selected automations in the workspace", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger": { - "post": { - "description": "Trigger the existing automation to execute immediately.", - "operationId": "triggerExistingAutomation", - "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "in": "query", + "name": "offset", + "required": false, "schema": { - "type": "string" + "format": "int32", + "type": "integer" } }, { - "in": "path", - "name": "automationId", - "required": true, + "in": "query", + "name": "limit", + "required": false, "schema": { - "type": "string" + "format": "int32", + "type": "integer" } } ], "responses": { - "204": { - "description": "The automation is successfully triggered." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ForecastResult" + } + } + }, + "description": "OK" } }, - "summary": "Trigger existing automation.", + "summary": "Smart functions - Forecast Result", "tags": [ - "Automations", + "Smart Functions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { - "delete": { - "operationId": "unsubscribeAutomation", + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": { + "post": { + "description": "Computes forecasted data points from the provided execution result and parameters.", + "operationId": "forecast", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { + "description": "Input result ID to be used in the computation", + "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", - "name": "automationId", + "name": "resultId", "required": true, "schema": { "type": "string" } - } - ], - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Unsubscribe from an automation", - "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides": { - "post": { - "description": "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", - "operationId": "checkEntityOverrides", - "parameters": [ + }, { - "in": "path", - "name": "workspaceId", - "required": true, + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } } ], @@ -43291,11 +50123,7 @@ "content": { "application/json": { "schema": { - "description": "An array of object identifications", - "items": { - "$ref": "#/components/schemas/HierarchyObjectIdentification" - }, - "type": "array" + "$ref": "#/components/schemas/ForecastRequest" } } }, @@ -43306,70 +50134,101 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" + "$ref": "#/components/schemas/SmartFunctionResponse" } } }, - "description": "Searching for entities finished successfully." + "description": "OK" } }, - "summary": "Finds entities with given ID in hierarchy.", + "summary": "Smart functions - Forecast", "tags": [ - "Hierarchy", + "Smart Functions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "ANALYZE" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph": { - "get": { - "description": "Computes the dependent entities graph", - "operationId": "getDependentEntitiesGraph", + "/api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute": { + "post": { + "description": "(BETA) Fetches a stored visualization object by ID, converts it to an AFM execution, and returns a link to the result. Optionally accepts additional AFM filters merged on top of the visualization's own filters.", + "operationId": "computeReportForVisualizationObject", "parameters": [ { + "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "visualizationObjectId", + "required": true, "schema": { "type": "string" } + }, + { + "description": "Ignore all caches during execution of current request.", + "in": "header", + "name": "skip-cache", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VisualizationObjectExecution" + } + } + } + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DependentEntitiesResponse" + "$ref": "#/components/schemas/AfmExecutionResponse" } } }, - "description": "Computes the dependent entities graph" + "description": "AFM Execution response with links to the result and server-enhanced dimensions.", + "headers": { + "X-GDC-CANCEL-TOKEN": { + "description": "A token that can be used to cancel this execution", + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, - "summary": "Computes the dependent entities graph", + "summary": "(BETA) Executes a visualization object and returns link to the result", "tags": [ - "Dependency Graph", + "Computation", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to read the graph.", + "description": "Requires workspace VIEW permission.", "permissions": [ "VIEW" ] } - }, + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/image": { "post": { - "description": "Computes the dependent entities graph from given entry points", - "operationId": "getDependentEntitiesGraphFromEntryPoints", + "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.", + "operationId": "createImageExport", "parameters": [ { "in": "path", @@ -43378,157 +50237,207 @@ "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DependentEntitiesRequest" + "$ref": "#/components/schemas/ImageExportRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DependentEntitiesResponse" + "$ref": "#/components/schemas/ExportResponse" } } }, - "description": "Computes the dependent entities graph from given entry points" + "description": "Image export request created successfully." } }, - "summary": "Computes the dependent entities graph from given entry points", + "summary": "(EXPERIMENTAL) Create image export request", "tags": [ - "Dependency Graph", + "Image export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to read the graph.", + "description": "Permissions required to execute image export.", "permissions": [ - "VIEW" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { - "post": { - "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", - "operationId": "cancelExecutions", + "/api/v1/actions/workspaces/{workspaceId}/export/image/{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": "getImageExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "exportId", + "required": true, + "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmCancelTokens" + "responses": { + "200": { + "content": { + "image/png": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "Binary export result.", + "headers": { + "Content-Disposition": { + "schema": { + "example": "attachment; filename='result.png'", + "pattern": "attachment; filename='[^']+'", + "type": "string" + }, + "style": "simple" } } }, - "required": true - }, - "responses": { - "200": { + "202": { "content": { - "application/json": { + "image/png": { "schema": { - "$ref": "#/components/schemas/AfmCancelTokens" + "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": "Status of the cancellation operation." + "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "Applies all the given cancel tokens.", + "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ - "Computation", + "Image export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "VIEW" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { - "post": { - "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", - "operationId": "computeValidDescendants", + "/api/v1/actions/workspaces/{workspaceId}/export/image/{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/image endpoint. The metadata structure is not verified.", + "operationId": "getImageExportMetadata", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "in": "path", + "name": "exportId", + "required": true, + "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmValidDescendantsQuery" - } - } - }, - "required": true - }, "responses": { "200": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmValidDescendantsResponse" - } - } + "application/json": {} }, - "description": "Map of lists of attributes valid as descendants of the given attributes." + "description": "Json metadata representation" } }, - "summary": "(BETA) Valid descendants", + "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ - "Computation", + "Image export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to analyze data.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "ANALYZE" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects": { + "/api/v1/actions/workspaces/{workspaceId}/export/raw": { "post": { - "description": "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", - "operationId": "computeValidObjects", + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", + "operationId": "createRawExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -43537,324 +50446,306 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmValidObjectsQuery" + "$ref": "#/components/schemas/RawExportRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmValidObjectsResponse" + "$ref": "#/components/schemas/ExportResponse" } } }, - "description": "List of attributes, facts and metrics valid with respect to given AFM." + "description": "Raw export request created successfully." } }, - "summary": "Valid objects", + "summary": "(EXPERIMENTAL) Create raw export request", "tags": [ - "Computation", + "Raw export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view data.", + "description": "Permissions required to execute raw export.", "permissions": [ - "VIEW" + "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute": { - "post": { - "description": "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", - "operationId": "computeReport", + "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": { + "get": { + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId": "getRawExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "deprecated": true, - "example": "2020-06-03T10:15:30+01:00", - "in": "header", - "name": "timestamp", - "required": false, + "in": "path", + "name": "exportId", + "required": true, "schema": { - "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", - "format": "timestamp", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AfmExecution" - } - } - }, - "required": true - }, "responses": { "200": { "content": { - "application/json": { + "application/vnd.apache.arrow.file": { "schema": { - "$ref": "#/components/schemas/AfmExecutionResponse" + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" } } }, - "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", + "description": "Binary export result.", "headers": { - "X-GDC-CANCEL-TOKEN": { - "description": "A token that can be used to cancel this execution", + "Content-Disposition": { "schema": { + "example": "attachment; filename='result.csv'", + "pattern": "attachment; filename='[^']+'", "type": "string" }, "style": "simple" } } + }, + "202": { + "content": { + "application/vnd.apache.arrow.file": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.apache.arrow.stream": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "Executes analytical request and returns link to the result", + "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ - "Computation", + "Raw export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "VIEW" + "EXPORT_TABULAR" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { - "get": { - "description": "Gets a single execution result.", - "operationId": "retrieveResult", + "/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.", + "operationId": "createReportExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", - "in": "path", - "name": "resultId", - "required": true, "schema": { "type": "string" } }, - { - "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", - "example": "offset=1,10", - "explode": false, - "in": "query", - "name": "offset", - "required": false, - "schema": { - "default": [], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", - "example": "limit=1,10", - "explode": false, - "in": "query", - "name": "limit", - "required": false, - "schema": { - "default": [], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "style": "form" - }, - { - "description": "Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.", - "example": "excludedTotalDimensions=dim_0,dim_1", - "explode": false, - "in": "query", - "name": "excludedTotalDimensions", - "required": false, - "schema": { - "default": [], - "items": { - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "in": "header", - "name": "X-GDC-CANCEL-TOKEN", + "name": "X-Gdc-Debug", "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ReportExportRequest" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExecutionResult" + "$ref": "#/components/schemas/ExportResponse" } } }, - "description": "Execution result was found and returned." + "description": "Report export request created successfully." } }, - "summary": "Get a single execution result", + "summary": "(EXPERIMENTAL) Create report export request", "tags": [ - "Computation", + "Report export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", + "description": "Permissions required to execute report export.", "permissions": [ - "VIEW" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary": { + "/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}": { "get": { - "description": "(BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.", - "operationId": "retrieveResultBinary", + "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": "getReportExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "exportId", "required": true, "schema": { "type": "string" } - }, - { - "in": "header", - "name": "X-GDC-CANCEL-TOKEN", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { "200": { "content": { - "application/vnd.apache.arrow.file": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.apache.arrow.stream": { + "application/pdf": { "schema": { "format": "binary", "type": "string" } } }, - "description": "Execution result was found and returned.", + "description": "Binary export result.", "headers": { - "X-GDC-RESULT-TOTAL-ROWS": { - "description": "Total number of data rows in the full result.", + "Content-Disposition": { "schema": { - "format": "int64", - "type": "integer" + "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": "(BETA) Get a single execution result in Apache Arrow File or Stream format", + "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ - "Computation", + "Report export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "VIEW" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": { + "/api/v1/actions/workspaces/{workspaceId}/export/report/{exportId}/metadata": { "get": { - "description": "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", - "operationId": "retrieveExecutionMetadata", + "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.", + "operationId": "getReportExportMetadata", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "exportId", "required": true, "schema": { "type": "string" @@ -43864,65 +50755,44 @@ "responses": { "200": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ResultCacheMetadata" - } - } + "application/json": {} }, - "description": "Execution result's metadata was found and returned." + "description": "Json metadata representation" } }, - "summary": "Get a single execution result's metadata.", + "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ - "Computation", + "Report export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to analyze data.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "ANALYZE" + "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain": { + "/api/v1/actions/workspaces/{workspaceId}/export/slides": { "post": { - "description": "The resource provides static structures needed for investigation of a problem with given AFM.", - "operationId": "explainAFM", + "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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": "createSlidesExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request\n\n`GIT` - Git properties of current build", - "in": "query", - "name": "explainType", + "in": "header", + "name": "X-Gdc-Debug", "required": false, "schema": { - "enum": [ - "MAQL", - "GRPC_MODEL", - "GRPC_MODEL_SVG", - "WDF", - "QT", - "QT_SVG", - "OPT_QT", - "OPT_QT_SVG", - "SQL", - "SETTINGS", - "COMPRESSED_SQL", - "COMPRESSED_GRPC_MODEL_SVG", - "GIT" - ], - "type": "string" + "default": false, + "type": "boolean" } } ], @@ -43930,141 +50800,243 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmExecution" + "$ref": "#/components/schemas/SlidesExportRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { - "application/json": {}, - "application/sql": {}, - "application/zip": { + "application/json": { "schema": { - "description": "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/ExportResponse" } - }, - "image/svg+xml": {} + } }, - "description": "Requested resource" + "description": "Slides export request created successfully." } }, - "summary": "AFM explain resource.", + "summary": "(EXPERIMENTAL) Create slides export request", "tags": [ - "Computation", + "Slides export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to analyze data.", + "description": "Permissions required to execute slides export.", "permissions": [ - "ANALYZE" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": { - "post": { - "description": "Returns paged list of elements (values) of given label satisfying given filtering criteria.", - "operationId": "computeLabelElementsPost", + "/api/v1/actions/workspaces/{workspaceId}/export/slides/{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": "getSlidesExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", - "in": "query", - "name": "offset", - "required": false, + "in": "path", + "name": "exportId", + "required": true, "schema": { - "default": 0, - "format": "int32", - "maximum": 10000, - "minimum": 0, - "type": "integer" + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/zip": { + "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" + } + }, + "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "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 files", + "tags": [ + "Slides export", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/slides/{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/slides endpoint. The metadata structure is not verified.", + "operationId": "getSlidesExportMetadata", + "parameters": [ { - "description": "Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.", - "in": "query", - "name": "limit", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": 1000, - "format": "int32", - "maximum": 10000, - "minimum": 1, - "type": "integer" + "type": "string" } }, { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, + "in": "path", + "name": "exportId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementsRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ElementsResponse" - } - } + "application/json": {} }, - "description": "List of label values." + "description": "Json metadata representation" } }, - "summary": "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", + "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ - "Computation", + "Slides export", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to view a report or label elements.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "VIEW" + "EXPORT_PDF" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis": { + "/api/v1/actions/workspaces/{workspaceId}/export/tabular": { "post": { - "description": "Computes change analysis for the provided execution definition.", - "operationId": "changeAnalysis", + "description": "An tabular 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": "createTabularExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } @@ -44073,51 +51045,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChangeAnalysisRequest" + "$ref": "#/components/schemas/TabularExportRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ChangeAnalysisResponse" + "$ref": "#/components/schemas/ExportResponse" } } }, - "description": "OK" + "description": "Tabular export request created successfully." } }, - "summary": "Compute change analysis", + "summary": "Create tabular export request", "tags": [ - "Computation", + "Tabular export", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Permissions required to execute tabular export.", + "permissions": [ + "EXPORT_TABULAR" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}": { "get": { - "description": "Gets change analysis result.", - "operationId": "changeAnalysisResult", + "description": "After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", + "operationId": "getTabularExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "exportId", "required": true, "schema": { "type": "string" @@ -44127,41 +51101,114 @@ "responses": { "200": { "content": { - "application/json": { + "application/pdf": { "schema": { - "$ref": "#/components/schemas/ChangeAnalysisResult" + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/zip": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/html": { + "schema": { + "format": "binary", + "type": "string" } } }, - "description": "OK" + "description": "Binary export result.", + "headers": { + "Content-Disposition": { + "schema": { + "example": "attachment; filename='result.csv'", + "pattern": "attachment; filename='[^']+'", + "type": "string" + }, + "style": "simple" + } + } + }, + "202": { + "content": { + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/zip": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/csv": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "text/html": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, - "summary": "Get change analysis result", + "summary": "Retrieve exported files", "tags": [ - "Computation", + "Tabular export", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "EXPORT_TABULAR" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { + "/api/v1/actions/workspaces/{workspaceId}/export/visual": { "post": { - "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", - "operationId": "keyDriverAnalysis", + "description": "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.", + "operationId": "createPdfExport", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Ignore all caches during execution of current request.", "in": "header", - "name": "skip-cache", + "name": "X-Gdc-Debug", "required": false, "schema": { "default": false, @@ -44173,117 +51220,179 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/KeyDriversRequest" + "$ref": "#/components/schemas/VisualExportRequest" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/KeyDriversResponse" + "$ref": "#/components/schemas/ExportResponse" } } }, - "description": "OK" + "description": "Visual export request created successfully." } }, - "summary": "(EXPERIMENTAL) Compute key driver analysis", + "summary": "Create visual - pdf export request", "tags": [ - "Computation", - "actions" - ] + "actions", + "Visual export" + ], + "x-gdc-security-info": { + "description": "Permissions required to execute pdf export.", + "permissions": [ + "EXPORT_PDF" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}": { "get": { - "description": "(EXPERIMENTAL) Gets key driver analysis.", - "operationId": "keyDriverAnalysisResult", + "description": "Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.", + "operationId": "getExportedFile", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "exportId", "required": true, "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/pdf": { + "schema": { + "format": "binary", + "type": "string" + } + }, + "application/zip": { + "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": { + "format": "binary", + "type": "string" + } + }, + "application/zip": { + "schema": { + "format": "binary", + "type": "string" + } + } + }, + "description": "Request is accepted, provided exportId exists, but export is not yet ready." + } + }, + "summary": "Retrieve exported files", + "tags": [ + "actions", + "Visual export" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata": { + "get": { + "description": "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.", + "operationId": "getMetadata", + "parameters": [ { - "in": "query", - "name": "offset", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "format": "int32", - "type": "integer" + "type": "string" } }, { - "in": "query", - "name": "limit", - "required": false, + "in": "path", + "name": "exportId", + "required": true, "schema": { - "format": "int32", - "type": "integer" + "type": "string" } } ], "responses": { "200": { "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeyDriversResult" - } - } + "application/json": {} }, - "description": "OK" + "description": "Json metadata representation" } }, - "summary": "(EXPERIMENTAL) Get key driver analysis result", + "summary": "Retrieve metadata context", "tags": [ - "Computation", - "actions" - ] + "actions", + "Visual export" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "EXPORT_PDF" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers": { + "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions": { "post": { - "description": "(BETA) Computes outlier detection for the provided execution definition.", - "operationId": "outlierDetection", + "operationId": "manageFactPermissions", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, + "in": "path", + "name": "factId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], @@ -44291,73 +51400,55 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OutlierDetectionRequest" + "description": "An array of fact-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FactPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/FactPermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/OutlierDetectionResponse" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(BETA) Outlier Detection", + "summary": "Manage Permissions for a Fact", "tags": [ - "Computation", + "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions": { "get": { - "description": "(BETA) Gets outlier detection result.", - "operationId": "outlierDetectionResult", + "operationId": "factPermissions", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "factId", "required": true, "schema": { "type": "string" } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } } ], "responses": { @@ -44365,63 +51456,74 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OutlierDetectionResult" + "$ref": "#/components/schemas/FactPermissions" } } }, "description": "OK" } }, - "summary": "(BETA) Outlier Detection Result", + "summary": "Get Fact Permissions", "tags": [ - "Computation", + "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts": { "get": { - "deprecated": true, - "description": "(EXPERIMENTAL) Gets anomalies.", - "operationId": "anomalyDetectionResult", + "description": "Finds API identifier conflicts in given workspace hierarchy.", + "operationId": "inheritedEntityConflicts", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/IdentifierDuplications" + }, + "type": "array" + } + } + }, + "description": "Searching for conflicting identifiers finished successfully" + } + }, + "summary": "Finds identifier conflicts in workspace hierarchy.", + "tags": [ + "Hierarchy", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes": { + "get": { + "description": "Get used entity prefixes in hierarchy of parent workspaces", + "operationId": "inheritedEntityPrefixes", + "parameters": [ { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } } ], "responses": { @@ -44429,128 +51531,103 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnomalyDetectionResult" + "items": { + "type": "string" + }, + "type": "array" } } }, - "description": "OK" + "description": "Prefixes used in parent entities" } }, - "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection Result", + "summary": "Get used entity prefixes in hierarchy", "tags": [ - "Smart Functions", + "Hierarchy", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions": { "post": { - "deprecated": true, - "description": "(EXPERIMENTAL) Computes anomaly detection.", - "operationId": "anomalyDetection", + "operationId": "manageLabelPermissions", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Input result ID to be used in the computation", - "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", - "name": "resultId", + "name": "labelId", "required": true, "schema": { "type": "string" } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnomalyDetectionRequest" + "description": "An array of label-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/LabelPermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SmartFunctionResponse" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection", + "summary": "Manage Permissions for a Label", "tags": [ - "Smart Functions", + "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions": { "get": { - "description": "(EXPERIMENTAL) Gets clustering result.", - "operationId": "clusteringResult", + "operationId": "labelPermissions", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "labelId", "required": true, "schema": { "type": "string" } - }, - { - "in": "query", - "name": "offset", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } - }, - { - "in": "query", - "name": "limit", - "required": false, - "schema": { - "format": "int32", - "type": "integer" - } } ], "responses": { @@ -44558,126 +51635,134 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClusteringResult" + "$ref": "#/components/schemas/LabelPermissions" } } }, "description": "OK" } }, - "summary": "(EXPERIMENTAL) Smart functions - Clustering Result", + "summary": "Get Label Permissions", "tags": [ - "Smart Functions", + "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}": { + "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { "post": { - "description": "(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.", - "operationId": "clustering", + "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", + "operationId": "manageWorkspacePermissions", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "description": "Input result ID to be used in the computation", - "example": "9bd52018570364264fcf62d373da6bed313120e8", - "in": "path", - "name": "resultId", - "required": true, "schema": { "type": "string" } - }, - { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClusteringRequest" + "description": "An array of workspace permissions assignments", + "items": { + "$ref": "#/components/schemas/WorkspacePermissionAssignment" + }, + "type": "array" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SmartFunctionResponse" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(EXPERIMENTAL) Smart functions - Clustering", + "summary": "Manage Permissions for a Workspace", "tags": [ - "Smart Functions", + "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": { - "get": { - "description": "Gets forecast result.", - "operationId": "forecastResult", + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions": { + "post": { + "operationId": "manageMetricPermissions", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { - "description": "Result ID", - "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", - "name": "resultId", + "name": "metricId", "required": true, "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of metric-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/MetricPermissionsForAssigneeRule" + } + ] + }, + "type": "array" + } + } }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "(BETA) Manage Permissions for a Metric", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions": { + "get": { + "operationId": "metricPermissions", + "parameters": [ { - "in": "query", - "name": "offset", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "format": "int32", - "type": "integer" + "type": "string" } }, { - "in": "query", - "name": "limit", - "required": false, + "in": "path", + "name": "metricId", + "required": true, "schema": { - "format": "int32", - "type": "integer" + "type": "string" } } ], @@ -44686,49 +51771,79 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ForecastResult" + "$ref": "#/components/schemas/MetricPermissions" } } }, "description": "OK" } }, - "summary": "Smart functions - Forecast Result", + "summary": "(BETA) Get Metric Permissions", "tags": [ - "Smart Functions", + "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": { - "post": { - "description": "Computes forecasted data points from the provided execution result and parameters.", - "operationId": "forecast", + "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities": { + "get": { + "description": "Finds API identifier overrides in given workspace hierarchy.", + "operationId": "overriddenChildEntities", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/IdentifierDuplications" + }, + "type": "array" + } + } + }, + "description": "Searching for overridden identifiers finished successfully" + } + }, + "summary": "Finds identifier overrides in workspace hierarchy.", + "tags": [ + "Hierarchy", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/resolveSettings": { + "get": { + "description": "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", + "operationId": "workspaceResolveAllSettings", + "parameters": [ { - "description": "Input result ID to be used in the computation", - "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", - "name": "resultId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", "required": false, "schema": { "default": false, @@ -44736,62 +51851,49 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ForecastRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SmartFunctionResponse" + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" } } }, - "description": "OK" + "description": "Values for selected settings." } }, - "summary": "Smart functions - Forecast", + "summary": "Values for all settings.", "tags": [ - "Smart Functions", + "Workspaces - Settings", "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute": { + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + }, "post": { - "description": "(BETA) Fetches a stored visualization object by ID, converts it to an AFM execution, and returns a link to the result. Optionally accepts additional AFM filters merged on top of the visualization's own filters.", - "operationId": "computeReportForVisualizationObject", + "description": "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", + "operationId": "workspaceResolveSettings", "parameters": [ { - "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, - "schema": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - } - }, - { - "in": "path", - "name": "visualizationObjectId", - "required": true, "schema": { "type": "string" } }, { - "description": "Ignore all caches during execution of current request.", - "in": "header", - "name": "skip-cache", + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", "required": false, "schema": { "default": false, @@ -44803,49 +51905,44 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VisualizationObjectExecution" + "$ref": "#/components/schemas/ResolveSettingsRequest" } } - } + }, + "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AfmExecutionResponse" + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" } } }, - "description": "AFM Execution response with links to the result and server-enhanced dimensions.", - "headers": { - "X-GDC-CANCEL-TOKEN": { - "description": "A token that can be used to cancel this execution", - "schema": { - "type": "string" - }, - "style": "simple" - } - } + "description": "Values for selected settings." } }, - "summary": "(BETA) Executes a visualization object and returns link to the result", + "summary": "Values for selected settings.", "tags": [ - "Computation", + "Workspaces - Settings", "actions" ], "x-gdc-security-info": { - "description": "Requires workspace VIEW permission.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/image": { + "/api/v1/actions/workspaces/{workspaceId}/setCertification": { "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.", - "operationId": "createImageExport", + "description": "Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.", + "operationId": "setCertification", "parameters": [ { "in": "path", @@ -44860,41 +51957,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ImageExportRequest" + "$ref": "#/components/schemas/SetCertificationRequest" } } }, "required": true }, "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" - } - } - }, - "description": "Image export request created successfully." + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(EXPERIMENTAL) Create image export request", + "summary": "Set Certification", "tags": [ - "Image export", - "actions" + "actions", + "Certification" ], "x-gdc-security-info": { - "description": "Permissions required to execute image export.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}": { + "/api/v1/actions/workspaces/{workspaceId}/translations": { "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": "getImageExport", + "description": "Provides a list of effective translation tags.", + "operationId": "getTranslationTags", "parameters": [ { "in": "path", @@ -44903,100 +51994,40 @@ "schema": { "type": "string" } - }, - { - "in": "path", - "name": "exportId", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { "200": { "content": { - "image/png": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.png'", - "pattern": "attachment; filename='[^']+'", - "type": "string" - }, - "style": "simple" - } - } - }, - "202": { - "content": { - "image/png": { + "application/json": { "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": "string" }, "type": "array" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description": "Retrieved list of translation tags." } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", + "summary": "Get translation tags.", "tags": [ - "Image export", + "Translations", "actions" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/image/{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/image endpoint. The metadata structure is not verified.", - "operationId": "getImageExportMetadata", + "/api/v1/actions/workspaces/{workspaceId}/translations/clean": { + "post": { + "description": "Cleans up all translations for a particular locale.", + "operationId": "cleanTranslations", "parameters": [ { "in": "path", @@ -45005,41 +52036,90 @@ "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocaleRequest" + } + } }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "Translations were successfully removed." + } + }, + "summary": "Cleans up translations.", + "tags": [ + "Translations", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve": { + "post": { + "description": "Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.", + "operationId": "retrieveTranslations", + "parameters": [ { "in": "path", - "name": "exportId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocaleRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { - "application/json": {} + "application/xml": { + "schema": { + "$ref": "#/components/schemas/Xliff" + } + } }, - "description": "Json metadata representation" + "description": "XLIFF file containing translations for a particular locale." } }, - "summary": "(EXPERIMENTAL) Retrieve metadata context", + "summary": "Retrieve translations for entities.", "tags": [ - "Image export", + "Translations", "actions" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/raw": { + "/api/v1/actions/workspaces/{workspaceId}/translations/set": { "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.", - "operationId": "createRawExport", + "description": "Set translation for existing entities in a particular locale.", + "operationId": "setTranslations", "parameters": [ { "in": "path", @@ -45052,43 +52132,37 @@ ], "requestBody": { "content": { - "application/json": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/RawExportRequest" + "$ref": "#/components/schemas/Xliff" } } }, "required": true }, "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" - } - } - }, - "description": "Raw export request created successfully." + "204": { + "content": {}, + "description": "Translations were successfully set." } }, - "summary": "(EXPERIMENTAL) Create raw export request", + "summary": "Set translations for entities.", "tags": [ - "Raw export", + "Translations", "actions" ], "x-gdc-security-info": { - "description": "Permissions required to execute raw export.", + "description": "Minimal permission required to use this endpoint.", "permissions": [ - "EXPORT_TABULAR" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": { - "get": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", - "operationId": "getRawExport", + "/api/v1/actions/workspaces/{workspaceId}/uploadNotification": { + "post": { + "description": "Notification sets up all reports to be computed again with new data.", + "operationId": "registerWorkspaceUploadNotification", "parameters": [ { "in": "path", @@ -45097,91 +52171,166 @@ "schema": { "type": "string" } - }, + } + ], + "responses": { + "204": { + "content": {}, + "description": "An upload notification has been successfully registered." + } + }, + "summary": "Register an upload notification", + "tags": [ + "Invalidate Cache", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/userGroups": { + "get": { + "operationId": "listWorkspaceUserGroups", + "parameters": [ { "in": "path", - "name": "exportId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } + }, + { + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name. Note that user name is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" } ], "responses": { "200": { "content": { - "application/vnd.apache.arrow.file": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.apache.arrow.stream": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "text/csv": { + "application/json": { "schema": { - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/WorkspaceUserGroups" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.csv'", - "pattern": "attachment; filename='[^']+'", - "type": "string" - }, - "style": "simple" - } + "description": "OK" + } + }, + "tags": [ + "User management", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/users": { + "get": { + "operationId": "listWorkspaceUsers", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } }, - "202": { + { + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { "content": { - "application/vnd.apache.arrow.file": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.apache.arrow.stream": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "text/csv": { + "application/json": { "schema": { - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/WorkspaceUsers" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description": "OK" } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ - "Raw export", + "User management", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "EXPORT_TABULAR" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/export/slides": { + "/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions": { "post": { - "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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": "createSlidesExport", + "operationId": "manageVisualizationPermissions", "parameters": [ { "in": "path", @@ -45192,12 +52341,11 @@ } }, { - "in": "header", - "name": "X-Gdc-Debug", - "required": false, + "in": "path", + "name": "visualizationObjectId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], @@ -45205,41 +52353,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SlidesExportRequest" + "description": "An array of visualization-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/VisualizationPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/VisualizationPermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, "required": true }, "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ExportResponse" - } - } - }, - "description": "Slides export request created successfully." + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "(EXPERIMENTAL) Create slides export request", + "summary": "(BETA) Manage Permissions for a Visualization", "tags": [ - "Slides export", + "Permissions", "actions" - ], - "x-gdc-security-info": { - "description": "Permissions required to execute slides export.", - "permissions": [ - "EXPORT_PDF" - ] - } + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}": { + "/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions": { "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": "getSlidesExport", + "operationId": "visualizationPermissions", "parameters": [ { "in": "path", @@ -45251,7 +52397,7 @@ }, { "in": "path", - "name": "exportId", + "name": "visualizationObjectId", "required": true, "schema": { "type": "string" @@ -45261,598 +52407,611 @@ "responses": { "200": { "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "application/json": { "schema": { - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/VisualizationPermissions" } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Get Visualization Permissions", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/ailake/database/instances": { + "get": { + "description": "(BETA) Lists database instances in the organization's AI Lake.", + "operationId": "listAiLakeDatabaseInstances", + "parameters": [ + { + "description": "Zero-based page number.", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "description": "Zero-based page number.", + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Number of items per page.", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 50, + "description": "Number of items per page.", + "format": "int32", + "maximum": 500, + "minimum": 1, + "type": "integer" + } + }, + { + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "items": { + "type": "string" }, - "application/zip": { + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/JsonApiListDocumentDatabaseInstance" } } }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.pdf'", - "pattern": "attachment; filename='[^']+'", - "type": "string" - }, - "style": "simple" + "description": "AI Lake database instances successfully retrieved" + } + }, + "summary": "(BETA) List AI Lake Database instances", + "tags": [ + "AI Lake - Databases", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to list AI Lake database instances.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "description": "(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", + "operationId": "provisionAiLakeDatabaseInstance", + "parameters": [ + { + "in": "header", + "name": "operation-id", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProvisionDatabaseInstanceRequest" } } }, + "required": true + }, + "responses": { "202": { - "content": { - "application/pdf": { + "content": {}, + "description": "Accepted", + "headers": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, "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" - } + "type": "string" + }, + "style": "simple" }, - "application/vnd.openxmlformats-officedocument.presentationml.presentation": { + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, "schema": { - "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" - } + "type": "string" + }, + "style": "simple" } - }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + } } }, - "summary": "(EXPERIMENTAL) Retrieve exported files", + "summary": "(BETA) Create a new AILake Database instance", "tags": [ - "Slides export", - "actions" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to provision an AI Lake database instance.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/slides/{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/slides endpoint. The metadata structure is not verified.", - "operationId": "getSlidesExportMetadata", + "/api/v1/ailake/database/instances/{instanceId}": { + "delete": { + "description": "(BETA) Deletes an existing database in the organization's AI Lake. A database that still contains tables is not deleted, unless cascade is set. With cascade, every table in the database is dropped first, which cannot be undone. Returns an operation-id in the operation-id header the client can use to poll for the progress.", + "operationId": "deprovisionAiLakeDatabaseInstance", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { - "in": "path", - "name": "exportId", - "required": true, + "description": "Drop every table in the database before the database itself.", + "in": "query", + "name": "cascade", + "required": false, + "schema": { + "description": "Drop every table in the database before the database itself.", + "type": "boolean" + } + }, + { + "in": "header", + "name": "operation-id", + "required": false, "schema": { "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": {} - }, - "description": "Json metadata representation" + "202": { + "content": {}, + "description": "Accepted", + "headers": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + }, + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, - "summary": "(EXPERIMENTAL) Retrieve metadata context", + "summary": "(BETA) Delete an existing AILake Database instance", "tags": [ - "Slides export", - "actions" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to provision an AI Lake database instance.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/export/tabular": { - "post": { - "description": "An tabular 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": "createTabularExport", + }, + "get": { + "description": "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", + "operationId": "getAiLakeDatabaseInstance", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TabularExportRequest" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExportResponse" + "$ref": "#/components/schemas/JsonApiDocumentDatabaseInstance" } } }, - "description": "Tabular export request created successfully." + "description": "AI Lake database instance successfully retrieved" } }, - "summary": "Create tabular export request", + "summary": "(BETA) Get the specified AILake Database instance", "tags": [ - "Tabular export", - "actions" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to execute tabular export.", + "description": "Permissions required to get an AI Lake database instance.", "permissions": [ - "EXPORT_TABULAR" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}": { - "get": { - "description": "After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.", - "operationId": "getTabularExport", + "/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics": { + "post": { + "description": "(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.", + "operationId": "analyzeStatistics", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { - "in": "path", - "name": "exportId", - "required": true, + "in": "header", + "name": "operation-id", + "required": false, "schema": { "type": "string" } } ], - "responses": { - "200": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "text/csv": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "text/html": { - "schema": { - "format": "binary", - "type": "string" - } - } - }, - "description": "Binary export result.", - "headers": { - "Content-Disposition": { - "schema": { - "example": "attachment; filename='result.csv'", - "pattern": "attachment; filename='[^']+'", - "type": "string" - }, - "style": "simple" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyzeStatisticsRequest" } } }, + "required": true + }, + "responses": { "202": { - "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/zip": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "text/csv": { + "content": {}, + "description": "Statistics analysis scheduled.", + "headers": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, "schema": { - "format": "binary", "type": "string" - } + }, + "style": "simple" }, - "text/html": { + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, "schema": { - "format": "binary", "type": "string" - } + }, + "style": "simple" } - }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + } } }, - "summary": "Retrieve exported files", + "summary": "(BETA) Run ANALYZE TABLE for tables in a database instance", "tags": [ - "Tabular export", - "actions" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to analyze statistics.", "permissions": [ - "EXPORT_TABULAR" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/visual": { - "post": { - "description": "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.", - "operationId": "createPdfExport", + "/api/v1/ailake/database/instances/{instanceId}/dataSource": { + "patch": { + "description": "(BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.", + "operationId": "updateAiLakeDatabaseDataSource", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } - }, - { - "in": "header", - "name": "X-Gdc-Debug", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/VisualExportRequest" + "$ref": "#/components/schemas/UpdateDatabaseDataSourceRequest" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ExportResponse" + "$ref": "#/components/schemas/UpdateDatabaseDataSourceResponse" } } }, - "description": "Visual export request created successfully." + "description": "Data source successfully updated" } }, - "summary": "Create visual - pdf export request", + "summary": "(BETA) Update the data source of an AILake Database instance", "tags": [ - "actions", - "Visual export" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Permissions required to execute pdf export.", + "description": "Permissions required to update the data source of an AI Lake database instance.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}": { + "/api/v1/ailake/database/instances/{instanceId}/dataSources": { "get": { - "description": "Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.", - "operationId": "getExportedFile", + "description": "(BETA) Returns data source associations for the specified AI Lake database instance.", + "operationId": "listAiLakeDatabaseDataSources", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { - "in": "path", - "name": "exportId", - "required": true, + "description": "Zero-based page number.", + "in": "query", + "name": "page", + "required": false, "schema": { - "type": "string" + "default": 0, + "description": "Zero-based page number.", + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Number of items per page.", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 50, + "description": "Number of items per page.", + "format": "int32", + "maximum": 500, + "minimum": 1, + "type": "integer" + } + }, + { + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true } } ], "responses": { "200": { "content": { - "application/pdf": { - "schema": { - "format": "binary", - "type": "string" - } - }, - "application/zip": { - "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": { - "format": "binary", - "type": "string" - } - }, - "application/zip": { + "application/json": { "schema": { - "format": "binary", - "type": "string" + "$ref": "#/components/schemas/JsonApiListDocumentDataSourceInfo" } } }, - "description": "Request is accepted, provided exportId exists, but export is not yet ready." + "description": "Data sources successfully retrieved" } }, - "summary": "Retrieve exported files", + "summary": "(BETA) List data sources of an AILake Database instance", "tags": [ - "actions", - "Visual export" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to list data sources of an AI Lake database instance.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata": { - "get": { - "description": "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.", - "operationId": "getMetadata", + }, + "post": { + "description": "(BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.", + "operationId": "addAiLakeDatabaseDataSource", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "exportId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddDatabaseDataSourceRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { - "application/json": {} + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddDatabaseDataSourceResponse" + } + } }, - "description": "Json metadata representation" + "description": "Data source successfully added" } }, - "summary": "Retrieve metadata context", + "summary": "(BETA) Add a data source to an AILake Database instance", "tags": [ - "actions", - "Visual export" + "AI Lake - Databases", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to add a data source to an AI Lake database instance.", "permissions": [ - "EXPORT_PDF" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions": { - "post": { - "operationId": "manageFactPermissions", + "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}": { + "delete": { + "description": "(BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.", + "operationId": "removeAiLakeDatabaseDataSource", "parameters": [ { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", - "name": "workspaceId", + "name": "instanceId", "required": true, "schema": { + "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { + "description": "Identifier of the data source to remove.", "in": "path", - "name": "factId", + "name": "dataSourceId", "required": true, "schema": { + "description": "Identifier of the data source to remove.", "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of fact-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FactPermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/FactPermissionsForAssigneeRule" - } - ] - }, - "type": "array" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RemoveDatabaseDataSourceResponse" + } + } + }, + "description": "Data source successfully removed" } }, - "summary": "Manage Permissions for a Fact", + "summary": "(BETA) Remove a data source from an AILake Database instance", "tags": [ - "Permissions", - "actions" - ] + "AI Lake - Databases", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to remove a data source from an AI Lake database instance.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions": { + "/api/v1/ailake/objectStorages": { "get": { - "operationId": "factPermissions", + "description": "(BETA) Lists ObjectStorages registered for the organization. Pass the returned `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.", + "operationId": "listAiLakeObjectStorages", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "description": "Zero-based page number.", + "in": "query", + "name": "page", + "required": false, "schema": { - "type": "string" + "default": 0, + "description": "Zero-based page number.", + "format": "int32", + "minimum": 0, + "type": "integer" } }, { - "in": "path", - "name": "factId", - "required": true, + "description": "Number of items per page.", + "in": "query", + "name": "size", + "required": false, "schema": { - "type": "string" + "default": 50, + "description": "Number of items per page.", + "format": "int32", + "maximum": 500, + "minimum": 1, + "type": "integer" + } + }, + { + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true } } ], @@ -45861,28 +53020,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FactPermissions" + "$ref": "#/components/schemas/JsonApiListDocumentObjectStorageInfo" } } }, - "description": "OK" + "description": "AI Lake ObjectStorages successfully retrieved" } }, - "summary": "Get Fact Permissions", + "summary": "(BETA) List registered AI Lake ObjectStorages", "tags": [ - "Permissions", - "actions" - ] + "AI Lake - Databases", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to list registered AI Lake ObjectStorages.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts": { + "/api/v1/ailake/operations/{operationId}": { "get": { - "description": "Finds API identifier conflicts in given workspace hierarchy.", - "operationId": "inheritedEntityConflicts", + "description": "(BETA) Retrieves details of a Long Running Operation specified by the operation-id.", + "operationId": "getAiLakeOperation", "parameters": [ { + "description": "Operation ID", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "in": "path", - "name": "workspaceId", + "name": "operationId", "required": true, "schema": { "type": "string" @@ -45894,40 +53061,78 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" + "oneOf": [ + { + "$ref": "#/components/schemas/FailedOperation" + }, + { + "$ref": "#/components/schemas/PendingOperation" + }, + { + "$ref": "#/components/schemas/SucceededOperation" + } + ] } } }, - "description": "Searching for conflicting identifiers finished successfully" + "description": "AI Lake Long Running Operation details successfully retrieved" } }, - "summary": "Finds identifier conflicts in workspace hierarchy.", + "summary": "(BETA) Get Long Running Operation details", "tags": [ - "Hierarchy", - "actions" + "AI Lake - Services & Operations", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to get details of a Long Running Operation.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes": { + "/api/v1/ailake/services": { "get": { - "description": "Get used entity prefixes in hierarchy of parent workspaces", - "operationId": "inheritedEntityPrefixes", + "description": "(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name).", + "operationId": "listAiLakeServices", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "description": "Zero-based page number.", + "in": "query", + "name": "page", + "required": false, "schema": { - "type": "string" + "default": 0, + "description": "Zero-based page number.", + "format": "int32", + "minimum": 0, + "type": "integer" + } + }, + { + "description": "Number of items per page.", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 50, + "description": "Number of items per page.", + "format": "int32", + "maximum": 500, + "minimum": 1, + "type": "integer" + } + }, + { + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "items": { + "type": "string" + }, + "type": "array", + "uniqueItems": true } } ], @@ -45936,36 +53141,34 @@ "content": { "application/json": { "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiListDocumentServiceInfo" } } }, - "description": "Prefixes used in parent entities" + "description": "AI Lake services successfully retrieved" } }, - "summary": "Get used entity prefixes in hierarchy", + "summary": "(BETA) List AI Lake services", "tags": [ - "Hierarchy", - "actions" + "AI Lake - Services & Operations", + "AI Lake" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to list AI Lake services.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions": { + "/api/v1/ailake/services/{serviceId}/commands/{commandName}/run": { "post": { - "operationId": "manageLabelPermissions", + "description": "(BETA) Runs a specific AI Lake service command.", + "operationId": "runAiLakeServiceCommand", "parameters": [ { "in": "path", - "name": "workspaceId", + "name": "serviceId", "required": true, "schema": { "type": "string" @@ -45973,62 +53176,78 @@ }, { "in": "path", - "name": "labelId", + "name": "commandName", "required": true, "schema": { "type": "string" } + }, + { + "in": "header", + "name": "operation-id", + "required": false, + "schema": { + "type": "string" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "An array of label-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/LabelPermissionsForAssigneeRule" - } - ] - }, - "type": "array" + "$ref": "#/components/schemas/RunServiceCommandRequest" } } }, "required": true }, "responses": { - "204": { + "202": { "content": {}, - "description": "No Content" + "description": "Accepted", + "headers": { + "operation-id": { + "description": "Operation ID to use for polling.", + "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + }, + "operation-location": { + "description": "Operation location URL that can be used for polling.", + "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", + "required": true, + "schema": { + "type": "string" + }, + "style": "simple" + } + } } }, - "summary": "Manage Permissions for a Label", + "summary": "(BETA) Run an AI Lake services command", "tags": [ - "Permissions", - "actions" - ] + "AI Lake - Services & Operations", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to run AI Lake service commands.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions": { + "/api/v1/ailake/services/{serviceId}/status": { "get": { - "operationId": "labelPermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, + "description": "(BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness).", + "operationId": "getAiLakeServiceStatus", + "parameters": [ { "in": "path", - "name": "labelId", + "name": "serviceId", "required": true, "schema": { "type": "string" @@ -46040,77 +53259,78 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LabelPermissions" + "$ref": "#/components/schemas/GetServiceStatusResponse" } } }, - "description": "OK" + "description": "AI Lake service status successfully retrieved" } }, - "summary": "Get Label Permissions", + "summary": "(BETA) Get AI Lake service status", "tags": [ - "Permissions", - "actions" - ] + "AI Lake - Services & Operations", + "AI Lake" + ], + "x-gdc-security-info": { + "description": "Permissions required to get AI Lake service status.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { - "post": { - "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", - "operationId": "manageWorkspacePermissions", + "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { + "get": { + "operationId": "getEntity@CookieSecurityConfigurations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of workspace permissions assignments", - "items": { - "$ref": "#/components/schemas/WorkspacePermissionAssignment" - }, - "type": "array" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Manage Permissions for a Workspace", + "summary": "Get CookieSecurityConfiguration", "tags": [ - "Permissions", - "actions" + "Cookie Security Configuration", + "entities", + "cookie-security-configuration-controller" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions": { - "post": { - "operationId": "manageMetricPermissions", + }, + "patch": { + "operationId": "patchEntity@CookieSecurityConfigurations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "path", - "name": "metricId", - "required": true, + "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -46120,140 +53340,158 @@ "content": { "application/json": { "schema": { - "description": "An array of metric-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/MetricPermissionsForAssigneeRule" - } - ] - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" } } }, "required": true }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "(BETA) Manage Permissions for a Metric", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions": { - "get": { - "operationId": "metricPermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "metricId", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MetricPermissions" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, - "summary": "(BETA) Get Metric Permissions", + "summary": "Patch CookieSecurityConfiguration", "tags": [ - "Permissions", - "actions" + "Cookie Security Configuration", + "entities", + "cookie-security-configuration-controller" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities": { - "get": { - "description": "Finds API identifier overrides in given workspace hierarchy.", - "operationId": "overriddenChildEntities", + }, + "put": { + "operationId": "updateEntity@CookieSecurityConfigurations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, - "description": "Searching for overridden identifiers finished successfully" + "description": "Request successfully processed" } }, - "summary": "Finds identifier overrides in workspace hierarchy.", + "summary": "Put CookieSecurityConfiguration", "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "Cookie Security Configuration", + "entities", + "cookie-security-configuration-controller" + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/resolveSettings": { + "/api/v1/entities/admin/organizations/{id}": { "get": { - "description": "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", - "operationId": "workspaceResolveAllSettings", + "operationId": "getEntity@Organizations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "description": "If true, user-level settings are excluded from resolution.", + "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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode": false, "in": "query", - "name": "excludeUserSettings", + "name": "include", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "items": { + "enum": [ + "users", + "userGroups", + "identityProviders", + "bootstrapUser", + "bootstrapUserGroup", + "identityProvider", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -46261,56 +53499,81 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } } }, - "description": "Values for selected settings." + "description": "Request successfully processed" } }, - "summary": "Values for all settings.", + "summary": "Get Organizations", "tags": [ - "Workspaces - Settings", - "actions" + "Organization - Entity APIs", + "entities", + "organization-entity-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains permissions required to manipulate the Organization.", "permissions": [ - "VIEW" + "MANAGE" ] } }, - "post": { - "description": "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", - "operationId": "workspaceResolveSettings", + "patch": { + "operationId": "patchEntity@Organizations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "description": "If true, user-level settings are excluded from resolution.", + "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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode": false, "in": "query", - "name": "excludeUserSettings", + "name": "include", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "items": { + "enum": [ + "users", + "userGroups", + "identityProviders", + "bootstrapUser", + "bootstrapUserGroup", + "identityProvider", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResolveSettingsRequest" + "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" } } }, @@ -46321,84 +53584,182 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } } }, - "description": "Values for selected settings." + "description": "Request successfully processed" } }, - "summary": "Values for selected settings.", + "summary": "Patch Organization", "tags": [ - "Workspaces - Settings", - "actions" + "Organization - Entity APIs", + "entities", + "organization-entity-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains permissions required to manipulate the Organization.", "permissions": [ - "VIEW" + "MANAGE" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/setCertification": { - "post": { - "description": "Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.", - "operationId": "setCertification", + }, + "put": { + "operationId": "updateEntity@Organizations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "identityProviders", + "bootstrapUser", + "bootstrapUserGroup", + "identityProvider", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SetCertificationRequest" + "$ref": "#/components/schemas/JsonApiOrganizationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationInDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Set Certification", + "summary": "Put Organization", "tags": [ - "actions", - "Certification" + "Organization - Entity APIs", + "entities", + "organization-entity-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains permissions required to manipulate the Organization.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/translations": { + "/api/v1/entities/agents": { "get": { - "description": "Provides a list of effective translation tags.", - "operationId": "getTranslationTags", + "operationId": "getAllEntities@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "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": "enabled==BooleanValue;name==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,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -46406,376 +53767,408 @@ "content": { "application/json": { "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiAgentOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutList" } } }, - "description": "Retrieved list of translation tags." + "description": "Request successfully processed" } }, - "summary": "Get translation tags.", + "summary": "Get all Agent entities", "tags": [ - "Translations", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/clean": { + }, "post": { - "description": "Cleans up all translations for a particular locale.", - "operationId": "cleanTranslations", + "description": "AI Agent - behavior configuration for AI assistants", + "operationId": "createEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "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": "createdBy,modifiedBy,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LocaleRequest" + "$ref": "#/components/schemas/JsonApiAgentInDocument" } - } - }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "Translations were successfully removed." - } - }, - "summary": "Cleans up translations.", - "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve": { - "post": { - "description": "Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.", - "operationId": "retrieveTranslations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { + }, + "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/LocaleRequest" + "$ref": "#/components/schemas/JsonApiAgentInDocument" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { - "application/xml": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Xliff" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "XLIFF file containing translations for a particular locale." + "description": "Request successfully processed" } }, - "summary": "Retrieve translations for entities.", + "summary": "Post Agent entities", "tags": [ - "Translations", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/translations/set": { - "post": { - "description": "Set translation for existing entities in a particular locale.", - "operationId": "setTranslations", + "/api/v1/entities/agents/{id}": { + "delete": { + "operationId": "deleteEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" } ], - "requestBody": { - "content": { - "application/xml": { - "schema": { - "$ref": "#/components/schemas/Xliff" - } - } - }, - "required": true - }, "responses": { "204": { - "content": {}, - "description": "Translations were successfully set." + "$ref": "#/components/responses/Deleted" } }, - "summary": "Set translations for entities.", + "summary": "Delete Agent entity", "tags": [ - "Translations", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/uploadNotification": { - "post": { - "description": "Notification sets up all reports to be computed again with new data.", - "operationId": "registerWorkspaceUploadNotification", + }, + "get": { + "operationId": "getEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "enabled==BooleanValue;name==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,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { - "204": { - "content": {}, - "description": "An upload notification has been successfully registered." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Register an upload notification", + "summary": "Get Agent entity", "tags": [ - "Invalidate Cache", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/userGroups": { - "get": { - "operationId": "listWorkspaceUserGroups", + }, + "patch": { + "operationId": "patchEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" + "$ref": "#/components/parameters/idPathParameter" }, { - "description": "The size of the page to be returned.", - "example": "size=20", + "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", - "name": "size", - "required": false, + "name": "filter", "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" + "type": "string" + } }, { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", + "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,userGroups", + "explode": false, "in": "query", - "name": "name", + "name": "include", "required": false, "schema": { - "type": "string" + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceUserGroups" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, + "summary": "Patch Agent entity", "tags": [ - "User management", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/users": { - "get": { - "operationId": "listWorkspaceUsers", + "Agents", + "entities", + "agent-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" + "$ref": "#/components/parameters/idPathParameter" }, { - "description": "The size of the page to be returned.", - "example": "size=20", + "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", - "name": "size", - "required": false, + "name": "filter", "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" + "type": "string" + } }, { - "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", - "example": "name=charles", + "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,userGroups", + "explode": false, "in": "query", - "name": "name", + "name": "include", "required": false, "schema": { - "type": "string" + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceUsers" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, + "summary": "Put Agent entity", "tags": [ - "User management", - "actions" - ] + "Agents", + "entities", + "agent-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/ailake/database/instances": { + "/api/v1/entities/colorPalettes": { "get": { - "description": "(BETA) Lists database instances in the organization's AI Lake.", - "operationId": "listAiLakeDatabaseInstances", + "operationId": "getAllEntities@ColorPalettes", "parameters": [ { - "description": "Zero-based page number.", + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "name==someString;content==JsonNodeValue", "in": "query", - "name": "page", - "required": false, + "name": "filter", "schema": { - "default": 0, - "description": "Zero-based page number.", - "format": "int32", - "minimum": 0, - "type": "integer" + "type": "string" } }, { - "description": "Number of items per page.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 50, - "description": "Number of items per page.", - "format": "int32", - "maximum": 500, - "minimum": 1, - "type": "integer" - } + "$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": { @@ -46783,160 +54176,111 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentDatabaseInstance" + "$ref": "#/components/schemas/JsonApiColorPaletteOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutList" } } }, - "description": "AI Lake database instances successfully retrieved" - } - }, - "summary": "(BETA) List AI Lake Database instances", - "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to list AI Lake database instances.", - "permissions": [ - "MANAGE" - ] - } - }, - "post": { - "description": "(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", - "operationId": "provisionAiLakeDatabaseInstance", - "parameters": [ - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } + "description": "Request successfully processed" } - ], + }, + "summary": "Get all Color Pallettes", + "tags": [ + "Appearance", + "entities", + "color-palette-controller" + ] + }, + "post": { + "operationId": "createEntity@ColorPalettes", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProvisionDatabaseInstanceRequest" + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } } }, "required": true }, "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "201": { + "content": { + "application/json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } }, - "operation-location": { - "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "application/vnd.gooddata.api+json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } } - } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Create a new AILake Database instance", + "summary": "Post Color Pallettes", "tags": [ - "AI Lake - Databases", - "AI Lake" + "Appearance", + "entities", + "color-palette-controller" ], "x-gdc-security-info": { - "description": "Permissions required to provision an AI Lake database instance.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/ailake/database/instances/{instanceId}": { + "/api/v1/entities/colorPalettes/{id}": { "delete": { - "description": "(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", - "operationId": "deprovisionAiLakeDatabaseInstance", + "operationId": "deleteEntity@ColorPalettes", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" } ], "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - }, - "operation-location": { - "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, - "schema": { - "type": "string" - }, - "style": "simple" - } - } + "204": { + "$ref": "#/components/responses/Deleted" } }, - "summary": "(BETA) Delete an existing AILake Database instance", + "summary": "Delete a Color Pallette", "tags": [ - "AI Lake - Databases", - "AI Lake" + "Appearance", + "entities", + "color-palette-controller" ], "x-gdc-security-info": { - "description": "Permissions required to provision an AI Lake database instance.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { - "description": "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", - "operationId": "getAiLakeDatabaseInstance", + "operationId": "getEntity@ColorPalettes", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, + "$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;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } @@ -46946,45 +54290,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDocumentDatabaseInstance" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "AI Lake database instance successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) Get the specified AILake Database instance", + "summary": "Get Color Pallette", "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to get an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics": { - "post": { - "description": "(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.", - "operationId": "analyzeStatistics", + "Appearance", + "entities", + "color-palette-controller" + ] + }, + "patch": { + "operationId": "patchEntity@ColorPalettes", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "header", - "name": "operation-id", - "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": "name==someString;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -46994,52 +54329,59 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyzeStatisticsRequest" + "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" } } }, "required": true }, "responses": { - "202": { - "content": {}, - "description": "Statistics analysis scheduled.", - "headers": { - "operation-id": { + "200": { + "content": { + "application/json": { "schema": { - "format": "uuid", - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } } - } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Run ANALYZE TABLE for tables in a database instance", + "summary": "Patch Color Pallette", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" + "Appearance", + "entities", + "color-palette-controller" ], "x-gdc-security-info": { - "description": "Permissions required to analyze statistics.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } - } - }, - "/api/v1/ailake/database/instances/{instanceId}/dataSource": { - "patch": { - "description": "(BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.", - "operationId": "updateAiLakeDatabaseDataSource", + }, + "put": { + "operationId": "updateEntity@ColorPalettes", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, + "$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;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } @@ -47048,7 +54390,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateDatabaseDataSourceRequest" + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } } }, @@ -47059,79 +54406,76 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UpdateDatabaseDataSourceResponse" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "Data source successfully updated" + "description": "Request successfully processed" } }, - "summary": "(BETA) Update the data source of an AILake Database instance", + "summary": "Put Color Pallette", "tags": [ - "AI Lake - Databases", - "AI Lake" + "Appearance", + "entities", + "color-palette-controller" ], "x-gdc-security-info": { - "description": "Permissions required to update the data source of an AI Lake database instance.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/ailake/database/instances/{instanceId}/dataSources": { + "/api/v1/entities/cspDirectives": { "get": { - "description": "(BETA) Returns data source associations for the specified AI Lake database instance.", - "operationId": "listAiLakeDatabaseDataSources", + "description": " Context Security Police Directive", + "operationId": "getAllEntities@CspDirectives", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, + "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": "sources==v1,v2,v3", + "in": "query", + "name": "filter", "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { - "description": "Zero-based page number.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "description": "Zero-based page number.", - "format": "int32", - "minimum": 0, - "type": "integer" - } + "$ref": "#/components/parameters/page" }, { - "description": "Number of items per page.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 50, - "description": "Number of items per page.", - "format": "int32", - "maximum": 500, - "minimum": 1, - "type": "integer" - } + "$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": { @@ -47139,179 +54483,286 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentDataSourceInfo" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" } } }, - "description": "Data sources successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) List data sources of an AILake Database instance", + "summary": "Get CSP Directives", "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to list data sources of an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } + "CSP Directives", + "entities", + "csp-directive-controller" + ] }, "post": { - "description": "(BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.", - "operationId": "addAiLakeDatabaseDataSource", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - } - ], + "description": " Context Security Police Directive", + "operationId": "createEntity@CspDirectives", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddDatabaseDataSourceRequest" + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddDatabaseDataSourceResponse" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Data source successfully added" + "description": "Request successfully processed" } }, - "summary": "(BETA) Add a data source to an AILake Database instance", + "summary": "Post CSP Directives", "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to add a data source to an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } + "CSP Directives", + "entities", + "csp-directive-controller" + ] } }, - "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}": { + "/api/v1/entities/cspDirectives/{id}": { "delete": { - "description": "(BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.", - "operationId": "removeAiLakeDatabaseDataSource", + "description": " Context Security Police Directive", + "operationId": "deleteEntity@CspDirectives", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete CSP Directives", + "tags": [ + "CSP Directives", + "entities", + "csp-directive-controller" + ] + }, + "get": { + "description": " Context Security Police Directive", + "operationId": "getEntity@CspDirectives", + "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": "sources==v1,v2,v3", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get CSP Directives", + "tags": [ + "CSP Directives", + "entities", + "csp-directive-controller" + ] + }, + "patch": { + "description": " Context Security Police Directive", + "operationId": "patchEntity@CspDirectives", + "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": "sources==v1,v2,v3", + "in": "query", + "name": "filter", "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" + } + } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch CSP Directives", + "tags": [ + "CSP Directives", + "entities", + "csp-directive-controller" + ] + }, + "put": { + "description": " Context Security Police Directive", + "operationId": "updateEntity@CspDirectives", + "parameters": [ { - "description": "Identifier of the data source to remove.", - "in": "path", - "name": "dataSourceId", - "required": true, + "$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": "sources==v1,v2,v3", + "in": "query", + "name": "filter", "schema": { - "description": "Identifier of the data source to remove.", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RemoveDatabaseDataSourceResponse" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Data source successfully removed" + "description": "Request successfully processed" } }, - "summary": "(BETA) Remove a data source from an AILake Database instance", + "summary": "Put CSP Directives", "tags": [ - "AI Lake - Databases", - "AI Lake" - ], - "x-gdc-security-info": { - "description": "Permissions required to remove a data source from an AI Lake database instance.", - "permissions": [ - "MANAGE" - ] - } + "CSP Directives", + "entities", + "csp-directive-controller" + ] } }, - "/api/v1/ailake/database/instances/{instanceId}/pipeTables": { + "/api/v1/entities/customGeoCollections": { "get": { - "description": "(BETA) Lists active pipe tables in the given AI Lake database instance.", - "operationId": "listAiLakePipeTables", + "operationId": "getAllEntities@CustomGeoCollections", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, + "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;description==someString", + "in": "query", + "name": "filter", "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { - "description": "Zero-based page number.", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "description": "Zero-based page number.", - "format": "int32", - "minimum": 0, - "type": "integer" - } + "$ref": "#/components/parameters/page" }, { - "description": "Number of items per page.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 50, - "description": "Number of items per page.", - "format": "int32", - "maximum": 500, - "minimum": 1, - "type": "integer" - } + "$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": { @@ -47319,248 +54770,193 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentPipeTableSummary" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" } } }, - "description": "AI Lake pipe tables successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) List AI Lake pipe tables", + "summary": "Get all Custom Geo Collections", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to list AI Lake pipe tables.", - "permissions": [ - "MANAGE" - ] - } + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] }, "post": { - "description": "(BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.", - "operationId": "createAiLakePipeTable", - "parameters": [ - { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, - { - "in": "header", - "name": "operation-id", - "required": false, - "schema": { - "type": "string" - } - } - ], + "operationId": "createEntity@CustomGeoCollections", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CreatePipeTableRequest" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, "required": true }, "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "201": { + "content": { + "application/json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } }, - "operation-location": { - "description": "Operation location URL.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "application/vnd.gooddata.api+json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } } - } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Create a new AI Lake pipe table", + "summary": "Post Custom Geo Collections", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to create an AI Lake pipe table.", - "permissions": [ - "MANAGE" - ] - } + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] } }, - "/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}": { + "/api/v1/entities/customGeoCollections/{id}": { "delete": { - "description": "(BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress.", - "operationId": "deleteAiLakePipeTable", + "operationId": "deleteEntity@CustomGeoCollections", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Custom Geo Collection", + "tags": [ + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] + }, + "get": { + "operationId": "getEntity@CustomGeoCollections", + "parameters": [ { - "description": "Pipe table name.", - "in": "path", - "name": "tableName", - "required": true, - "schema": { - "description": "Pipe table name.", - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "header", - "name": "operation-id", - "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": "name==someString;description==someString", + "in": "query", + "name": "filter", "schema": { "type": "string" } } ], "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "200": { + "content": { + "application/json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } }, - "operation-location": { - "description": "Operation location URL.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "application/vnd.gooddata.api+json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } } - } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Delete an AI Lake pipe table", + "summary": "Get Custom Geo Collection", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to delete an AI Lake pipe table.", - "permissions": [ - "MANAGE" - ] - } + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] }, - "get": { - "description": "(BETA) Returns full details of the specified pipe table.", - "operationId": "getAiLakePipeTable", + "patch": { + "operationId": "patchEntity@CustomGeoCollections", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "description": "Pipe table name.", - "in": "path", - "name": "tableName", - "required": true, + "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;description==someString", + "in": "query", + "name": "filter", "schema": { - "description": "Pipe table name.", "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDocumentPipeTable" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "AI Lake pipe table successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) Get an AI Lake pipe table", + "summary": "Patch Custom Geo Collection", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to get an AI Lake pipe table.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh": { - "post": { - "description": "(BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress.", - "operationId": "refreshAiLakePipeTablePartition", + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] + }, + "put": { + "operationId": "updateEntity@CustomGeoCollections", "parameters": [ { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "in": "path", - "name": "instanceId", - "required": true, - "schema": { - "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", - "type": "string" - } - }, - { - "description": "Pipe table name.", - "in": "path", - "name": "tableName", - "required": true, - "schema": { - "description": "Pipe table name.", - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "header", - "name": "operation-id", - "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": "name==someString;description==someString", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -47570,94 +54966,86 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RefreshPartitionRequest" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, "required": true }, "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "200": { + "content": { + "application/json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } }, - "operation-location": { - "description": "Operation location URL.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "application/vnd.gooddata.api+json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } } - } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Refresh a pipe table partition", + "summary": "Put Custom Geo Collection", "tags": [ - "AI Lake", - "AI Lake - Pipe Tables" - ], - "x-gdc-security-info": { - "description": "Permissions required to refresh an AI Lake pipe table partition.", - "permissions": [ - "MANAGE" - ] - } + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] } }, - "/api/v1/ailake/objectStorages": { + "/api/v1/entities/dataSourceIdentifiers": { "get": { - "description": "(BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped — only safe descriptors (id, name, type, bucket, region, endpoint, …) are returned.", - "operationId": "listAiLakeObjectStorages", + "operationId": "getAllEntities@DataSourceIdentifiers", "parameters": [ { - "description": "Zero-based page number.", + "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;schema==someString", "in": "query", - "name": "page", - "required": false, + "name": "filter", "schema": { - "default": 0, - "description": "Zero-based page number.", - "format": "int32", - "minimum": 0, - "type": "integer" + "type": "string" } }, { - "description": "Number of items per page.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 50, - "description": "Number of items per page.", - "format": "int32", - "maximum": 500, - "minimum": 1, - "type": "integer" - } + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" }, { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,page,all", + "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { + "enum": [ + "permissions", + "page", + "all", + "ALL" + ], "type": "string" }, "type": "array", "uniqueItems": true - } + }, + "style": "form" } ], "responses": { @@ -47665,40 +55053,69 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentObjectStorageInfo" + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" } } }, - "description": "AI Lake ObjectStorages successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) List registered AI Lake ObjectStorages", + "summary": "Get all Data Source Identifiers", "tags": [ - "AI Lake - Databases", - "AI Lake" + "Data Source - Entity APIs", + "entities", + "data-source-identifier-controller" ], "x-gdc-security-info": { - "description": "Permissions required to list registered AI Lake ObjectStorages.", + "description": "Contains minimal permission level required to use this object type.", "permissions": [ - "MANAGE" + "USE" ] } } }, - "/api/v1/ailake/operations/{operationId}": { + "/api/v1/entities/dataSourceIdentifiers/{id}": { "get": { - "description": "(BETA) Retrieves details of a Long Running Operation specified by the operation-id.", - "operationId": "getAiLakeOperation", + "operationId": "getEntity@DataSourceIdentifiers", "parameters": [ { - "description": "Operation ID", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "in": "path", - "name": "operationId", - "required": true, + "$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;schema==someString", + "in": "query", + "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -47706,79 +55123,77 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/FailedOperation" - }, - { - "$ref": "#/components/schemas/PendingOperation" - }, - { - "$ref": "#/components/schemas/SucceededOperation" - } - ] + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" } } }, - "description": "AI Lake Long Running Operation details successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) Get Long Running Operation details", + "summary": "Get Data Source Identifier", "tags": [ - "AI Lake - Services & Operations", - "AI Lake" + "Data Source - Entity APIs", + "entities", + "data-source-identifier-controller" ], "x-gdc-security-info": { - "description": "Permissions required to get details of a Long Running Operation.", + "description": "Contains minimal permission level required to use this object type.", "permissions": [ - "MANAGE" + "USE" ] } } }, - "/api/v1/ailake/services": { + "/api/v1/entities/dataSources": { "get": { - "description": "(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name).", - "operationId": "listAiLakeServices", + "description": "Data Source - represents data source for the workspace", + "operationId": "getAllEntities@DataSources", "parameters": [ { - "description": "Zero-based page number.", + "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;type==DatabaseTypeValue", "in": "query", - "name": "page", - "required": false, + "name": "filter", "schema": { - "default": 0, - "description": "Zero-based page number.", - "format": "int32", - "minimum": 0, - "type": "integer" + "type": "string" } }, { - "description": "Number of items per page.", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 50, - "description": "Number of items per page.", - "format": "int32", - "maximum": 500, - "minimum": 1, - "type": "integer" - } + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" }, { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,page,all", + "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { + "enum": [ + "permissions", + "page", + "all", + "ALL" + ], "type": "string" }, "type": "array", "uniqueItems": true - } + }, + "style": "form" } ], "responses": { @@ -47786,159 +55201,168 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiListDocumentServiceInfo" + "$ref": "#/components/schemas/JsonApiDataSourceOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceOutList" } } }, - "description": "AI Lake services successfully retrieved" + "description": "Request successfully processed" } }, - "summary": "(BETA) List AI Lake services", + "summary": "Get Data Source entities", "tags": [ - "AI Lake - Services & Operations", - "AI Lake" + "Data Source - Entity APIs", + "entities", + "data-source-controller" ], "x-gdc-security-info": { - "description": "Permissions required to list AI Lake services.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } - } - }, - "/api/v1/ailake/services/{serviceId}/commands/{commandName}/run": { + }, "post": { - "description": "(BETA) Runs a specific AI Lake service command.", - "operationId": "runAiLakeServiceCommand", + "description": "Data Source - represents data source for the workspace", + "operationId": "createEntity@DataSources", "parameters": [ { - "in": "path", - "name": "serviceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "commandName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "operation-id", + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, + "in": "query", + "name": "metaInclude", "required": false, "schema": { - "type": "string" - } + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RunServiceCommandRequest" + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } } }, "required": true }, "responses": { - "202": { - "content": {}, - "description": "Accepted", - "headers": { - "operation-id": { - "description": "Operation ID to use for polling.", - "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "201": { + "content": { + "application/json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + } }, - "operation-location": { - "description": "Operation location URL that can be used for polling.", - "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", - "required": true, + "application/vnd.gooddata.api+json": { "schema": { - "type": "string" - }, - "style": "simple" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + } } - } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Run an AI Lake services command", + "summary": "Post Data Sources", "tags": [ - "AI Lake - Services & Operations", - "AI Lake" + "Data Source - Entity APIs", + "entities", + "data-source-controller" ], "x-gdc-security-info": { - "description": "Permissions required to run AI Lake service commands.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/ailake/services/{serviceId}/status": { - "get": { - "description": "(BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness).", - "operationId": "getAiLakeServiceStatus", + "/api/v1/entities/dataSources/{id}": { + "delete": { + "description": "Data Source - represents data source for the workspace", + "operationId": "deleteEntity@DataSources", "parameters": [ { - "in": "path", - "name": "serviceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetServiceStatusResponse" - } - } - }, - "description": "AI Lake service status successfully retrieved" + "204": { + "$ref": "#/components/responses/Deleted" } }, - "summary": "(BETA) Get AI Lake service status", + "summary": "Delete Data Source entity", "tags": [ - "AI Lake - Services & Operations", - "AI Lake" + "Data Source - Entity APIs", + "entities", + "data-source-controller" ], "x-gdc-security-info": { - "description": "Permissions required to get AI Lake service status.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } - } - }, - "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { + }, "get": { - "operationId": "getEntity@CookieSecurityConfigurations", + "description": "Data Source - represents data source for the workspace", + "operationId": "getEntity@DataSources", "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -47946,34 +55370,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get CookieSecurityConfiguration", + "summary": "Get Data Source entity", "tags": [ - "Cookie Security Configuration", + "Data Source - Entity APIs", "entities", - "cookie-security-configuration-controller" - ] + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "operationId": "patchEntity@CookieSecurityConfigurations", + "description": "Data Source - represents data source for the workspace", + "operationId": "patchEntity@DataSources", "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { @@ -47985,12 +55416,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" + "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" + "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" } } }, @@ -48001,34 +55432,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch CookieSecurityConfiguration", + "summary": "Patch Data Source entity", "tags": [ - "Cookie Security Configuration", + "Data Source - Entity APIs", "entities", - "cookie-security-configuration-controller" - ] + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { - "operationId": "updateEntity@CookieSecurityConfigurations", + "description": "Data Source - represents data source for the workspace", + "operationId": "updateEntity@DataSources", "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { @@ -48040,12 +55478,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } } }, @@ -48056,36 +55494,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put CookieSecurityConfiguration", + "summary": "Put Data Source entity", "tags": [ - "Cookie Security Configuration", + "Data Source - Entity APIs", "entities", - "cookie-security-configuration-controller" - ] + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/admin/organizations/{id}": { + "/api/v1/entities/entitlements": { "get": { - "operationId": "getEntity@Organizations", + "description": "Space of the shared interest", + "operationId": "getAllEntities@Entitlements", "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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "example": "value==someString;expiry==LocalDateValue", "in": "query", "name": "filter", "schema": { @@ -48093,32 +55535,17 @@ } }, { - "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": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", + "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48127,7 +55554,7 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", + "page", "all", "ALL" ], @@ -48144,237 +55571,94 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Organizations", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-entity-controller" - ], - "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "operationId": "patchEntity@Organizations", - "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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiEntitlementOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiEntitlementOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Organization", + "summary": "Get Entitlements", "tags": [ - "Organization - Entity APIs", + "Entitlement", "entities", - "organization-entity-controller" + "entitlement-entity-controller" ], "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@Organizations", + } + }, + "/api/v1/entities/entitlements/{id}": { + "get": { + "description": "Space of the shared interest", + "operationId": "getEntity@Entitlements", "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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "example": "value==someString;expiry==LocalDateValue", "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": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationInDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Organization", + "summary": "Get Entitlement entity", "tags": [ - "Organization - Entity APIs", + "Entitlement", "entities", - "organization-entity-controller" + "entitlement-entity-controller" ], "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/agents": { + "/api/v1/entities/exportTemplates": { "get": { - "operationId": "getAllEntities@Agents", + "operationId": "getAllEntities@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -48412,68 +55696,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutList" + "$ref": "#/components/schemas/JsonApiExportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutList" + "$ref": "#/components/schemas/JsonApiExportTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Agent entities", + "summary": "GET all Export Template entities", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "export-template-controller" + ] }, "post": { - "description": "AI Agent - behavior configuration for AI assistants", - "operationId": "createEntity@Agents", - "parameters": [ - { - "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], + "operationId": "createEntity@ExportTemplates", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } } }, @@ -48484,23 +55737,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Agent entities", + "summary": "Post Export Template entities", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48510,9 +55763,9 @@ } } }, - "/api/v1/entities/agents/{id}": { + "/api/v1/entities/exportTemplates/{id}": { "delete": { - "operationId": "deleteEntity@Agents", + "operationId": "deleteEntity@ExportTemplates", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -48523,11 +55776,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Agent entity", + "summary": "Delete Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48537,41 +55790,19 @@ } }, "get": { - "operationId": "getEntity@Agents", + "operationId": "getEntity@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "responses": { @@ -48579,79 +55810,51 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Agent entity", + "summary": "GET Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "export-template-controller" + ] }, "patch": { - "operationId": "patchEntity@Agents", + "operationId": "patchEntity@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" } } }, @@ -48662,23 +55865,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Agent entity", + "summary": "Patch Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48688,53 +55891,31 @@ } }, "put": { - "operationId": "updateEntity@Agents", + "operationId": "updateEntity@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" } } }, @@ -48745,23 +55926,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Agent entity", + "summary": "PUT Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48771,13 +55952,13 @@ } } }, - "/api/v1/entities/colorPalettes": { + "/api/v1/entities/identityProviders": { "get": { - "operationId": "getAllEntities@ColorPalettes", + "operationId": "getAllEntities@IdentityProviders", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -48821,37 +56002,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutList" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutList" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Color Pallettes", + "summary": "Get all Identity Providers", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" - ] + "identity-provider-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "post": { - "operationId": "createEntity@ColorPalettes", + "operationId": "createEntity@IdentityProviders", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, @@ -48862,23 +56049,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Color Pallettes", + "summary": "Post Identity Providers", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48888,9 +56075,9 @@ } } }, - "/api/v1/entities/colorPalettes/{id}": { + "/api/v1/entities/identityProviders/{id}": { "delete": { - "operationId": "deleteEntity@ColorPalettes", + "operationId": "deleteEntity@IdentityProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -48901,11 +56088,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Color Pallette", + "summary": "Delete Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -48915,14 +56102,14 @@ } }, "get": { - "operationId": "getEntity@ColorPalettes", + "operationId": "getEntity@IdentityProviders", "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;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -48935,34 +56122,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Color Pallette", + "summary": "Get Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" - ] + "identity-provider-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "operationId": "patchEntity@ColorPalettes", + "operationId": "patchEntity@IdentityProviders", "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;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -48974,12 +56167,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" } } }, @@ -48990,23 +56183,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Color Pallette", + "summary": "Patch Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49016,14 +56209,14 @@ } }, "put": { - "operationId": "updateEntity@ColorPalettes", + "operationId": "updateEntity@IdentityProviders", "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;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -49035,12 +56228,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, @@ -49051,23 +56244,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Color Pallette", + "summary": "Put Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49077,20 +56270,39 @@ } } }, - "/api/v1/entities/cspDirectives": { + "/api/v1/entities/ipAllowlistPolicies": { "get": { - "description": " Context Security Police Directive", - "operationId": "getAllEntities@CspDirectives", + "operationId": "getAllEntities@IpAllowlistPolicies", "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": "sources==v1,v2,v3", + "example": "allowedSources==v1,v2,v3", "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": "users,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -49128,38 +56340,65 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get CSP Directives", + "summary": "Get all IpAllowlistPolicy entities", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "post": { - "description": " Context Security Police Directive", - "operationId": "createEntity@CspDirectives", + "operationId": "createEntity@IpAllowlistPolicies", + "parameters": [ + { + "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": "users,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } } }, @@ -49170,30 +56409,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post CSP Directives", + "summary": "Post IpAllowlistPolicy entities", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/cspDirectives/{id}": { + "/api/v1/entities/ipAllowlistPolicies/{id}": { "delete": { - "description": " Context Security Police Directive", - "operationId": "deleteEntity@CspDirectives", + "operationId": "deleteEntity@IpAllowlistPolicies", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -49204,137 +56448,131 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete CSP Directives", + "summary": "Delete IpAllowlistPolicy entity", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "get": { - "description": " Context Security Police Directive", - "operationId": "getEntity@CspDirectives", + "operationId": "getEntity@IpAllowlistPolicies", "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": "sources==v1,v2,v3", + "example": "allowedSources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "csp-directive-controller" - ] - }, - "patch": { - "description": " Context Security Police Directive", - "operationId": "patchEntity@CspDirectives", - "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": "sources==v1,v2,v3", + "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": "users,userGroups", + "explode": false, "in": "query", - "name": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch CSP Directives", + "summary": "Get IpAllowlistPolicy entity", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "put": { - "description": " Context Security Police Directive", - "operationId": "updateEntity@CspDirectives", + "operationId": "updateEntity@IpAllowlistPolicies", "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": "sources==v1,v2,v3", + "example": "allowedSources==v1,v2,v3", "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": "users,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } } }, @@ -49345,33 +56583,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put CSP Directives", + "summary": "Put IpAllowlistPolicy entity", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/customGeoCollections": { + "/api/v1/entities/jwks": { "get": { - "operationId": "getAllEntities@CustomGeoCollections", + "description": "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", + "operationId": "getAllEntities@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -49415,37 +56660,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + "$ref": "#/components/schemas/JsonApiJwkOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + "$ref": "#/components/schemas/JsonApiJwkOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Custom Geo Collections", + "summary": "Get all Jwks", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" + "jwk-controller" ] }, "post": { - "operationId": "createEntity@CustomGeoCollections", + "description": "Creates JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "createEntity@Jwks", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } } }, @@ -49456,29 +56702,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Custom Geo Collections", + "summary": "Post Jwks", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/customGeoCollections/{id}": { + "/api/v1/entities/jwks/{id}": { "delete": { - "operationId": "deleteEntity@CustomGeoCollections", + "description": "Deletes JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "deleteEntity@Jwks", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -49489,22 +56742,29 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Custom Geo Collection", + "summary": "Delete Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "get": { - "operationId": "getEntity@CustomGeoCollections", + "description": "Returns JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "getEntity@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -49517,34 +56777,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Custom Geo Collection", + "summary": "Get Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" + "jwk-controller" ] }, "patch": { - "operationId": "patchEntity@CustomGeoCollections", + "description": "Patches JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "patchEntity@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -49556,12 +56817,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + "$ref": "#/components/schemas/JsonApiJwkPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + "$ref": "#/components/schemas/JsonApiJwkPatchDocument" } } }, @@ -49572,34 +56833,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Custom Geo Collection", + "summary": "Patch Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { - "operationId": "updateEntity@CustomGeoCollections", + "description": "Updates JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "updateEntity@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -49611,12 +56879,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } } }, @@ -49627,181 +56895,173 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Custom Geo Collection", + "summary": "Put Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/dataSourceIdentifiers": { + "/api/v1/entities/llmEndpoints": { "get": { - "operationId": "getAllEntities@DataSourceIdentifiers", + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "getAllEntities", + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "Get all LLM endpoint entities (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] + }, + "post": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "createEntity", + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "Post LLM endpoint entities (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] + } + }, + "/api/v1/entities/llmEndpoints/{id}": { + "delete": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "deleteEntity", "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;schema==someString", - "in": "query", - "name": "filter", + "in": "path", + "name": "id", + "required": true, "schema": { "type": "string" } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" - } - } - }, - "description": "Request successfully processed" + "410": { + "description": "Gone" } }, - "summary": "Get all Data Source Identifiers", + "summary": "Delete LLM endpoint entity (Removed)", "tags": [ - "Data Source - Entity APIs", - "entities", - "data-source-identifier-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to use this object type.", - "permissions": [ - "USE" - ] - } - } - }, - "/api/v1/entities/dataSourceIdentifiers/{id}": { + "LLM Endpoints", + "entities" + ] + }, "get": { - "operationId": "getEntity@DataSourceIdentifiers", + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "getEntity", "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;schema==someString", - "in": "query", - "name": "filter", + "in": "path", + "name": "id", + "required": true, "schema": { "type": "string" } - }, + } + ], + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "Get LLM endpoint entity (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] + }, + "patch": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "patchEntity", + "parameters": [ { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, + "in": "path", + "name": "id", + "required": true, "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "type": "string" + } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" + "410": { + "description": "Gone" } }, - "summary": "Get Data Source Identifier", + "summary": "Patch LLM endpoint entity (Removed)", "tags": [ - "Data Source - Entity APIs", - "entities", - "data-source-identifier-controller" + "LLM Endpoints", + "entities" + ] + }, + "put": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "updateEntity", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to use this object type.", - "permissions": [ - "USE" - ] - } + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "PUT LLM endpoint entity (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] } }, - "/api/v1/entities/dataSources": { + "/api/v1/entities/llmProviders": { "get": { - "description": "Data Source - represents data source for the workspace", - "operationId": "getAllEntities@DataSources", + "operationId": "getAllEntities@LlmProviders", "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;type==DatabaseTypeValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -49819,7 +57079,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,page,all", + "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -49828,7 +57088,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "page", "all", "ALL" @@ -49846,68 +57105,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutList" + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutList" + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Data Source entities", + "summary": "Get all LLM Provider entities", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "llm-provider-controller" + ] }, "post": { - "description": "Data Source - represents data source for the workspace", - "operationId": "createEntity@DataSources", - "parameters": [ - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], + "description": "LLM Provider - connection configuration for LLM services", + "operationId": "createEntity@LlmProviders", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } } }, @@ -49918,23 +57147,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Data Sources", + "summary": "Post LLM Provider entities", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49944,10 +57173,9 @@ } } }, - "/api/v1/entities/dataSources/{id}": { + "/api/v1/entities/llmProviders/{id}": { "delete": { - "description": "Data Source - represents data source for the workspace", - "operationId": "deleteEntity@DataSources", + "operationId": "deleteEntity@LlmProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -49958,11 +57186,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Data Source entity", + "summary": "Delete LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49972,42 +57200,19 @@ } }, "get": { - "description": "Data Source - represents data source for the workspace", - "operationId": "getEntity@DataSources", + "operationId": "getEntity@LlmProviders", "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;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": 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": "name==someString;description==someString", "in": "query", - "name": "metaInclude", - "required": false, + "name": "filter", "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "type": "string" + } } ], "responses": { @@ -50015,41 +57220,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Data Source entity", + "summary": "Get LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "llm-provider-controller" + ] }, "patch": { - "description": "Data Source - represents data source for the workspace", - "operationId": "patchEntity@DataSources", + "operationId": "patchEntity@LlmProviders", "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;type==DatabaseTypeValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50061,12 +57259,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" } } }, @@ -50077,23 +57275,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Data Source entity", + "summary": "Patch LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50103,15 +57301,14 @@ } }, "put": { - "description": "Data Source - represents data source for the workspace", - "operationId": "updateEntity@DataSources", + "operationId": "updateEntity@LlmProviders", "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;type==DatabaseTypeValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50123,12 +57320,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } } }, @@ -50139,23 +57336,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Data Source entity", + "summary": "PUT LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50165,14 +57362,13 @@ } } }, - "/api/v1/entities/entitlements": { + "/api/v1/entities/notificationChannelIdentifiers": { "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Entitlements", + "operationId": "getAllEntities@NotificationChannelIdentifiers", "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": "value==someString;expiry==LocalDateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50216,43 +57412,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Entitlements", + "summary": "Get all Notification Channel Identifier entities", "tags": [ - "Entitlement", + "Notification Channels", "entities", - "entitlement-entity-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "notification-channel-identifier-controller" + ] } }, - "/api/v1/entities/entitlements/{id}": { + "/api/v1/entities/notificationChannelIdentifiers/{id}": { "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Entitlements", + "operationId": "getEntity@NotificationChannelIdentifiers", "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": "value==someString;expiry==LocalDateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50265,39 +57454,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Entitlement entity", + "summary": "Get Notification Channel Identifier entity", "tags": [ - "Entitlement", + "Notification Channels", "entities", - "entitlement-entity-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "notification-channel-identifier-controller" + ] } }, - "/api/v1/entities/exportTemplates": { + "/api/v1/entities/notificationChannels": { "get": { - "operationId": "getAllEntities@ExportTemplates", + "operationId": "getAllEntities@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50341,37 +57524,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" } } }, "description": "Request successfully processed" } }, - "summary": "GET all Export Template entities", + "summary": "Get all Notification Channel entities", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ] }, "post": { - "operationId": "createEntity@ExportTemplates", + "operationId": "createEntity@NotificationChannels", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } } }, @@ -50382,23 +57565,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Export Template entities", + "summary": "Post Notification Channel entities", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50408,9 +57591,9 @@ } } }, - "/api/v1/entities/exportTemplates/{id}": { + "/api/v1/entities/notificationChannels/{id}": { "delete": { - "operationId": "deleteEntity@ExportTemplates", + "operationId": "deleteEntity@NotificationChannels", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -50421,11 +57604,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Export Template entity", + "summary": "Delete Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50435,14 +57618,14 @@ } }, "get": { - "operationId": "getEntity@ExportTemplates", + "operationId": "getEntity@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50455,34 +57638,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "GET Export Template entity", + "summary": "Get Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ] }, "patch": { - "operationId": "patchEntity@ExportTemplates", + "operationId": "patchEntity@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50494,12 +57677,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" } } }, @@ -50510,23 +57693,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Export Template entity", + "summary": "Patch Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50536,14 +57719,14 @@ } }, "put": { - "operationId": "updateEntity@ExportTemplates", + "operationId": "updateEntity@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -50555,12 +57738,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" } } }, @@ -50571,23 +57754,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "PUT Export Template entity", + "summary": "Put Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50597,19 +57780,40 @@ } } }, - "/api/v1/entities/identityProviders": { + "/api/v1/entities/orgMemoryItems": { "get": { - "operationId": "getAllEntities@IdentityProviders", + "operationId": "getAllEntities@OrgMemoryItems", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -50647,204 +57851,94 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Identity Providers", + "summary": "Get all organization Memory Item entities", "tags": [ - "Identity Providers", + "Memory Items", "entities", - "identity-provider-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "post": { - "operationId": "createEntity@IdentityProviders", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Identity Providers", - "tags": [ - "Identity Providers", - "entities", - "identity-provider-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/identityProviders/{id}": { - "delete": { - "operationId": "deleteEntity@IdentityProviders", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "identity-provider-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "operationId": "getEntity@IdentityProviders", + "description": "Organization-scoped AI memory item", + "operationId": "createEntity@OrgMemoryItems", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "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": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } + "type": "array" }, - "description": "Request successfully processed" - } - }, - "summary": "Get Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "identity-provider-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "operationId": "patchEntity@IdentityProviders", - "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": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Identity Provider", + "summary": "Post organization Memory Item entities", "tags": [ - "Identity Providers", + "Memory Items", "entities", - "identity-provider-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50852,60 +57946,26 @@ "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@IdentityProviders", + } + }, + "/api/v1/entities/orgMemoryItems/{id}": { + "delete": { + "operationId": "deleteEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - } - }, - "required": true - }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" + "204": { + "$ref": "#/components/responses/Deleted" } }, - "summary": "Put Identity Provider", + "summary": "Delete an organization Memory Item entity", "tags": [ - "Identity Providers", + "Memory Items", "entities", - "identity-provider-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50913,69 +57973,40 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/ipAllowlistPolicies": { + }, "get": { - "operationId": "getAllEntities@IpAllowlistPolicies", + "operationId": "getEntity@OrgMemoryItems", "parameters": [ { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "allowedSources==v1,v2,v3", - "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": "users,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "$ref": "#/components/parameters/idPathParameter" }, { - "$ref": "#/components/parameters/sort" + "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": "Include Meta objects.", - "example": "metaInclude=page,all", + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } @@ -50985,23 +58016,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all IpAllowlistPolicy entities", + "summary": "Get an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "Memory Items", "entities", - "ip-allowlist-policy-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51010,12 +58041,24 @@ ] } }, - "post": { - "operationId": "createEntity@IpAllowlistPolicies", + "patch": { + "operationId": "patchEntity@OrgMemoryItems", "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "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": "users,userGroups", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -51023,8 +58066,9 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -51038,66 +58082,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post IpAllowlistPolicy entities", - "tags": [ - "Organization - Entity APIs", - "entities", - "ip-allowlist-policy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/ipAllowlistPolicies/{id}": { - "delete": { - "operationId": "deleteEntity@IpAllowlistPolicies", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete IpAllowlistPolicy entity", + "summary": "Patch an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "Memory Items", "entities", - "ip-allowlist-policy-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51106,15 +58123,15 @@ ] } }, - "get": { - "operationId": "getEntity@IpAllowlistPolicies", + "put": { + "operationId": "updateEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "allowedSources==v1,v2,v3", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -51123,7 +58140,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": "users,userGroups", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -51131,8 +58148,9 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -51142,45 +58160,96 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get IpAllowlistPolicy entity", + "summary": "Put an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "Memory Items", "entities", - "ip-allowlist-policy-controller" + "org-memory-item-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" ] } - }, - "put": { - "operationId": "updateEntity@IpAllowlistPolicies", + } + }, + "/api/v1/entities/organization": { + "get": { + "description": "Gets a basic information about organization.", + "operationId": "getOrganization", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" - }, + "description": "Return list of permissions available to logged user.", + "example": "metaInclude=permissions", + "explode": false, + "in": "query", + "name": "metaInclude", + "schema": { + "items": { + "description": "Available meta objects to include.", + "enum": [ + "permissions", + "all" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "302": { + "description": "Redirect to entity URI." + } + }, + "summary": "Get current organization info", + "tags": [ + "Organization - Entity APIs", + "entities" + ] + } + }, + "/api/v1/entities/organization/workspaceAutomations": { + "get": { + "operationId": "getAllAutomations@WorkspaceAutomations", + "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "allowedSources==v1,v2,v3", + "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", "in": "query", "name": "filter", "schema": { @@ -51189,7 +58258,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": "users,userGroups", + "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -51197,8 +58266,19 @@ "schema": { "items": { "enum": [ + "workspaces", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", "users", - "userGroups", + "automationResults", + "workspace", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -51206,62 +58286,77 @@ "type": "array" }, "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put IpAllowlistPolicy entity", + "summary": "Get all Automations across all Workspaces", "tags": [ - "Organization - Entity APIs", + "Automations", "entities", - "ip-allowlist-policy-controller" + "automation-organization-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/jwks": { + "/api/v1/entities/organizationSettings": { "get": { - "description": "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", - "operationId": "getAllEntities@Jwks", + "operationId": "getAllEntities@OrganizationSettings", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -51305,38 +58400,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutList" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutList" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Jwks", + "summary": "Get Organization Setting entities", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" - ] + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "post": { - "description": "Creates JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "createEntity@Jwks", + "operationId": "createEntity@OrganizationSettings", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, @@ -51347,23 +58447,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Jwks", + "summary": "Post Organization Setting entities", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" + "organization-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51373,10 +58473,9 @@ } } }, - "/api/v1/entities/jwks/{id}": { + "/api/v1/entities/organizationSettings/{id}": { "delete": { - "description": "Deletes JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "deleteEntity@Jwks", + "operationId": "deleteEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -51387,11 +58486,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Jwk", + "summary": "Delete Organization Setting entity", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" + "organization-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51401,15 +58500,14 @@ } }, "get": { - "description": "Returns JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "getEntity@Jwks", + "operationId": "getEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -51422,35 +58520,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Jwk", + "summary": "Get Organization Setting entity", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" - ] + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "description": "Patches JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "patchEntity@Jwks", + "operationId": "patchEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -51462,12 +58565,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkPatchDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkPatchDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } } }, @@ -51478,23 +58581,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Jwk", + "summary": "Patch Organization Setting entity", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" + "organization-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51504,15 +58607,14 @@ } }, "put": { - "description": "Updates JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "updateEntity@Jwks", + "operationId": "updateEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -51524,12 +58626,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, @@ -51540,173 +58642,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Jwk", - "tags": [ - "JWKS", - "entities", - "jwk-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/llmEndpoints": { - "get": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "getAllEntities", - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Get all LLM endpoint entities (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "post": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "createEntity", - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Post LLM endpoint entities (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - } - }, - "/api/v1/entities/llmEndpoints/{id}": { - "delete": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "deleteEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Delete LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "get": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "getEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Get LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "patch": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "patchEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Patch LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "put": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "updateEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "PUT LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] + "summary": "Put Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/llmProviders": { + "/api/v1/entities/themes": { "get": { - "operationId": "getAllEntities@LlmProviders", + "operationId": "getAllEntities@Themes", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51750,38 +58718,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + "$ref": "#/components/schemas/JsonApiThemeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + "$ref": "#/components/schemas/JsonApiThemeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all LLM Provider entities", + "summary": "Get all Theming entities", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ] }, "post": { - "description": "LLM Provider - connection configuration for LLM services", - "operationId": "createEntity@LlmProviders", + "operationId": "createEntity@Themes", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } } }, @@ -51792,23 +58759,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post LLM Provider entities", + "summary": "Post Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51818,9 +58785,9 @@ } } }, - "/api/v1/entities/llmProviders/{id}": { + "/api/v1/entities/themes/{id}": { "delete": { - "operationId": "deleteEntity@LlmProviders", + "operationId": "deleteEntity@Themes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -51831,11 +58798,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete LLM Provider entity", + "summary": "Delete Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51845,14 +58812,14 @@ } }, "get": { - "operationId": "getEntity@LlmProviders", + "operationId": "getEntity@Themes", "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;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51865,34 +58832,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get LLM Provider entity", + "summary": "Get Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ] }, "patch": { - "operationId": "patchEntity@LlmProviders", + "operationId": "patchEntity@Themes", "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;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51904,12 +58871,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiThemePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiThemePatchDocument" } } }, @@ -51920,23 +58887,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch LLM Provider entity", + "summary": "Patch Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51946,14 +58913,14 @@ } }, "put": { - "operationId": "updateEntity@LlmProviders", + "operationId": "updateEntity@Themes", "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;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -51965,12 +58932,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } } }, @@ -51981,23 +58948,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "PUT LLM Provider entity", + "summary": "Put Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52007,19 +58974,40 @@ } } }, - "/api/v1/entities/notificationChannelIdentifiers": { + "/api/v1/entities/userGroups": { "get": { - "operationId": "getAllEntities@NotificationChannelIdentifiers", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "getAllEntities@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -52057,149 +59045,66 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + "$ref": "#/components/schemas/JsonApiUserGroupOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + "$ref": "#/components/schemas/JsonApiUserGroupOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Notification Channel Identifier entities", + "summary": "Get UserGroup entities", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-identifier-controller" - ] - } - }, - "/api/v1/entities/notificationChannelIdentifiers/{id}": { - "get": { - "operationId": "getEntity@NotificationChannelIdentifiers", - "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;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } + "user-group-controller" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Notification Channel Identifier entity", - "tags": [ - "Notification Channels", - "entities", - "notification-channel-identifier-controller" - ] - } - }, - "/api/v1/entities/notificationChannels": { - "get": { - "operationId": "getAllEntities@NotificationChannels", + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "createEntity@UserGroups", "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;description==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", + "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": "parents", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "userGroups", + "parents", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Notification Channel entities", - "tags": [ - "Notification Channels", - "entities", - "notification-channel-controller" - ] - }, - "post": { - "operationId": "createEntity@NotificationChannels", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } } }, @@ -52210,23 +59115,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Notification Channel entities", + "summary": "Post User Group entities", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" + "user-group-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52236,9 +59141,10 @@ } } }, - "/api/v1/entities/notificationChannels/{id}": { + "/api/v1/entities/userGroups/{id}": { "delete": { - "operationId": "deleteEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "deleteEntity@UserGroups", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -52249,11 +59155,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Notification Channel entity", + "summary": "Delete UserGroup entity", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" + "user-group-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52263,19 +59169,40 @@ } }, "get": { - "operationId": "getEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "getEntity@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -52283,51 +59210,78 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Notification Channel entity", + "summary": "Get UserGroup entity", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" - ] + "user-group-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "operationId": "patchEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "patchEntity@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" + "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" + "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" } } }, @@ -52338,23 +59292,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Notification Channel entity", + "summary": "Patch UserGroup entity", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" + "user-group-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52364,31 +59318,52 @@ } }, "put": { - "operationId": "updateEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "updateEntity@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } } }, @@ -52399,39 +59374,154 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put UserGroup entity", + "tags": [ + "UserGroups - Entity APIs", + "entities", + "user-group-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/userIdentifiers": { + "get": { + "description": "UserIdentifier - represents entity interacting with platform", + "operationId": "getAllEntities@UserIdentifiers", + "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": "firstname==someString;lastname==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/JsonApiUserIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get UserIdentifier entities", + "tags": [ + "User Identifiers", + "entities", + "user-identifier-controller" + ] + } + }, + "/api/v1/entities/userIdentifiers/{id}": { + "get": { + "description": "UserIdentifier - represents basic information about entity interacting with platform", + "operationId": "getEntity@UserIdentifiers", + "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": "firstname==someString;lastname==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Notification Channel entity", + "summary": "Get UserIdentifier entity", "tags": [ - "Notification Channels", + "User Identifiers", "entities", - "notification-channel-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-identifier-controller" + ] } }, - "/api/v1/entities/orgMemoryItems": { + "/api/v1/entities/users": { "get": { - "operationId": "getAllEntities@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "getAllEntities@Users", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -52440,7 +59530,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -52448,9 +59538,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -52496,38 +59584,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all organization Memory Item entities", + "summary": "Get User entities", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-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" ] } }, "post": { - "description": "Organization-scoped AI memory item", - "operationId": "createEntity@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "createEntity@Users", "parameters": [ { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -52535,9 +59623,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -52551,12 +59637,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } } }, @@ -52567,23 +59653,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post organization Memory Item entities", + "summary": "Post User entities", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52593,9 +59679,10 @@ } } }, - "/api/v1/entities/orgMemoryItems/{id}": { + "/api/v1/entities/users/{id}": { "delete": { - "operationId": "deleteEntity@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "deleteEntity@Users", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -52606,11 +59693,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an organization Memory Item entity", + "summary": "Delete User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52620,14 +59707,15 @@ } }, "get": { - "operationId": "getEntity@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "getEntity@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": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -52636,7 +59724,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -52644,9 +59732,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -52661,40 +59747,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an organization Memory Item entity", + "summary": "Get User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-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" ] } }, "patch": { - "operationId": "patchEntity@OrgMemoryItems", + "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": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -52703,7 +59790,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -52711,9 +59798,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -52727,12 +59812,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserPatchDocument" } } }, @@ -52743,23 +59828,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an organization Memory Item entity", + "summary": "Patch User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52769,14 +59854,15 @@ } }, "put": { - "operationId": "updateEntity@OrgMemoryItems", + "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": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -52785,7 +59871,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -52793,9 +59879,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -52809,12 +59893,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } } }, @@ -52825,23 +59909,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an organization Memory Item entity", + "summary": "Put User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52851,87 +59935,27 @@ } } }, - "/api/v1/entities/organization": { + "/api/v1/entities/users/{userId}/apiTokens": { "get": { - "description": "Gets a basic information about organization.", - "operationId": "getOrganization", + "operationId": "getAllEntities@ApiTokens", "parameters": [ { - "description": "Return list of permissions available to logged user.", - "example": "metaInclude=permissions", - "explode": false, - "in": "query", - "name": "metaInclude", + "in": "path", + "name": "userId", + "required": true, "schema": { - "items": { - "description": "Available meta objects to include.", - "enum": [ - "permissions", - "all" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "type": "string" } - } - ], - "responses": { - "302": { - "description": "Redirect to entity URI." - } - }, - "summary": "Get current organization info", - "tags": [ - "Organization - Entity APIs", - "entities" - ] - } - }, - "/api/v1/entities/organization/workspaceAutomations": { - "get": { - "operationId": "getAllAutomations@WorkspaceAutomations", - "parameters": [ + }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "example": "bearerToken==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": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "workspace", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -52969,39 +59993,169 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiApiTokenOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiApiTokenOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations across all Workspaces", + "summary": "List all api tokens for a user", "tags": [ - "Automations", + "API tokens", "entities", - "automation-organization-view-controller" + "api-token-controller" + ] + }, + "post": { + "operationId": "createEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "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/organizationSettings": { + "/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": "getAllEntities@OrganizationSettings", + "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": "content==JsonNodeValue;type==SettingTypeValue", + "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": { @@ -53045,43 +60199,47 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Organization Setting entities", + "summary": "List all custom application settings for a user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "post": { - "operationId": "createEntity@OrganizationSettings", + "operationId": "createEntity@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" } } }, @@ -53092,36 +60250,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Organization Setting entities", + "summary": "Post a new custom application setting for the user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-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/organizationSettings/{id}": { + "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { "delete": { - "operationId": "deleteEntity@OrganizationSettings", + "operationId": "deleteEntity@CustomUserApplicationSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/idPathParameter" } @@ -53131,74 +60291,30 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Organization Setting entity", + "summary": "Delete a custom application setting for a user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "get": { - "operationId": "getEntity@OrganizationSettings", + "operationId": "getEntity@CustomUserApplicationSettings", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", + "in": "path", + "name": "userId", + "required": true, "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Organization Setting entity", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "operationId": "patchEntity@OrganizationSettings", - "parameters": [ + }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -53206,60 +60322,47 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Organization Setting entity", + "summary": "Get a custom application setting for a user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "put": { - "operationId": "updateEntity@OrganizationSettings", + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -53271,12 +60374,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } } }, @@ -53287,39 +60390,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Organization Setting entity", + "summary": "Put a custom application setting for the user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-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/themes": { + "/api/v1/entities/users/{userId}/userSettings": { "get": { - "operationId": "getAllEntities@Themes", + "operationId": "getAllEntities@UserSettings", "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": "name==someString;content==JsonNodeValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -53363,37 +60468,47 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Theming entities", + "summary": "List all settings for a user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" + "user-setting-controller" ] }, "post": { - "operationId": "createEntity@Themes", + "operationId": "createEntity@UserSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, @@ -53404,36 +60519,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Theming", + "summary": "Post new user settings for the user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-setting-controller" + ] } }, - "/api/v1/entities/themes/{id}": { + "/api/v1/entities/users/{userId}/userSettings/{id}": { "delete": { - "operationId": "deleteEntity@Themes", + "operationId": "deleteEntity@UserSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/idPathParameter" } @@ -53443,28 +60560,30 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Theming", + "summary": "Delete a setting for a user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-setting-controller" + ] }, "get": { - "operationId": "getEntity@Themes", + "operationId": "getEntity@UserSettings", "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": "name==someString;content==JsonNodeValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -53477,95 +60596,42 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Theming", + "summary": "Get a setting for a user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" + "user-setting-controller" ] }, - "patch": { - "operationId": "patchEntity@Themes", + "put": { + "operationId": "updateEntity@UserSettings", "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;content==JsonNodeValue", - "in": "query", - "name": "filter", + "in": "path", + "name": "userId", + "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemePatchDocument" - } - } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Patch Theming", - "tags": [ - "Appearance", - "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "put": { - "operationId": "updateEntity@Themes", - "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;content==JsonNodeValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -53577,12 +60643,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, @@ -53593,40 +60659,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Theming", + "summary": "Put new user settings for the user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-setting-controller" + ] } }, - "/api/v1/entities/userGroups": { + "/api/v1/entities/workspaces": { "get": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "getAllEntities@UserGroups", + "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", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -53635,7 +60695,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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -53643,8 +60703,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -53664,7 +60724,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -53673,6 +60733,10 @@ "description": "Included meta objects", "items": { "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", "page", "all", "ALL" @@ -53690,38 +60754,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get UserGroup entities", + "summary": "Get Workspace entities", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "post": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "createEntity@UserGroups", + "description": "Space of the shared interest", + "operationId": "createEntity@Workspaces", "parameters": [ { "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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -53729,8 +60793,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -53738,18 +60802,43 @@ "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/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, @@ -53760,23 +60849,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post User Group entities", + "summary": "Post Workspace entities", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -53786,10 +60875,10 @@ } } }, - "/api/v1/entities/userGroups/{id}": { + "/api/v1/entities/workspaces/{id}": { "delete": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "deleteEntity@UserGroups", + "description": "Space of the shared interest", + "operationId": "deleteEntity@Workspaces", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -53800,11 +60889,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete UserGroup entity", + "summary": "Delete Workspace entity", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -53814,15 +60903,15 @@ } }, "get": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "getEntity@UserGroups", + "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", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -53831,7 +60920,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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -53839,8 +60928,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -53848,130 +60937,73 @@ "type": "array" }, "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get UserGroup entity", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "user-group-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "patchEntity@UserGroups", - "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", - "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": "parents", + "description": "Include Meta objects.", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", "explode": false, "in": "query", - "name": "include", + "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { "enum": [ - "userGroups", - "parents", + "config", + "permissions", + "hierarchy", + "dataModelDatasets", + "all", "ALL" ], "type": "string" }, - "type": "array" + "type": "array", + "uniqueItems": true }, "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch UserGroup entity", + "summary": "Get Workspace entity", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, - "put": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "updateEntity@UserGroups", + "patch": { + "description": "Space of the shared interest", + "operationId": "patchEntity@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", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -53980,7 +61012,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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -53988,8 +61020,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -54003,12 +61035,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" } } }, @@ -54019,23 +61051,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put UserGroup entity", + "summary": "Patch Workspace entity", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -54043,16 +61075,17 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/userIdentifiers": { - "get": { - "description": "UserIdentifier - represents entity interacting with platform", - "operationId": "getAllEntities@UserIdentifiers", + }, + "put": { + "description": "Space of the shared interest", + "operationId": "updateEntity@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": "firstname==someString;lastname==someString", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -54060,113 +61093,102 @@ } }, { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "parent", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "workspaces", + "parent", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get UserIdentifier entities", + "summary": "Put Workspace entity", "tags": [ - "User Identifiers", + "Workspaces - Entity APIs", "entities", - "user-identifier-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/userIdentifiers/{id}": { + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { "get": { - "description": "UserIdentifier - represents basic information about entity interacting with platform", - "operationId": "getEntity@UserIdentifiers", + "operationId": "getAllEntities@AggregatedFacts", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "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": "firstname==someString;lastname==someString", "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" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get UserIdentifier entity", - "tags": [ - "User Identifiers", - "entities", - "user-identifier-controller" - ] - } - }, - "/api/v1/entities/users": { - "get": { - "description": "User - represents entity interacting with platform", - "operationId": "getAllEntities@Users", - "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": "authenticationId==someString;firstname==someString", + "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", "in": "query", "name": "filter", "schema": { @@ -54175,7 +61197,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": "userGroups", + "example": "dataset,sourceFact,sourceAttribute", "explode": false, "in": "query", "name": "include", @@ -54183,7 +61205,12 @@ "schema": { "items": { "enum": [ - "userGroups", + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", "ALL" ], "type": "string" @@ -54201,9 +61228,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", @@ -54212,6 +61248,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -54229,138 +61266,134 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get User entities", + "summary": "Get all Aggregated Facts", "tags": [ - "Users - Entity APIs", + "Facts", "entities", - "user-controller" + "aggregated-fact-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - }, + } + }, + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { "post": { - "description": "User - represents entity interacting with platform", - "operationId": "createEntity@Users", + "operationId": "searchEntities@AggregatedFacts", "parameters": [ { - "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": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { "in": "query", - "name": "include", + "name": "origin", "required": false, "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "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/JsonApiUserInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "$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/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post User entities", + "summary": "The search endpoint (beta)", "tags": [ - "Users - Entity APIs", + "Facts", "entities", - "user-controller" + "aggregated-fact-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/entities/users/{id}": { - "delete": { - "description": "User - represents entity interacting with platform", - "operationId": "deleteEntity@Users", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete 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/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { "get": { - "description": "User - represents entity interacting with platform", - "operationId": "getEntity@Users", + "operationId": "getEntity@AggregatedFacts", "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": "authenticationId==someString;firstname==someString", + "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", "in": "query", "name": "filter", "schema": { @@ -54369,7 +61402,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": "userGroups", + "example": "dataset,sourceFact,sourceAttribute", "explode": false, "in": "query", "name": "include", @@ -54377,7 +61410,12 @@ "schema": { "items": { "enum": [ - "userGroups", + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", "ALL" ], "type": "string" @@ -54385,6 +61423,37 @@ "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": { @@ -54392,41 +61461,62 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get User entity", + "summary": "Get an Aggregated Fact", "tags": [ - "Users - Entity APIs", + "Facts", "entities", - "user-controller" + "aggregated-fact-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - }, - "patch": { - "description": "User - represents entity interacting with platform", - "operationId": "patchEntity@Users", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { + "get": { + "operationId": "getAllEntities@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -54435,7 +61525,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": "userGroups", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -54443,7 +61533,19 @@ "schema": { "items": { "enum": [ - "userGroups", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -54451,168 +61553,126 @@ "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" + "$ref": "#/components/parameters/page" }, { - "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", + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } }, { - "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", + "description": "Include Meta objects.", + "example": "metaInclude=permissions,origin,accessInfo,page,all", "explode": false, "in": "query", - "name": "include", + "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { "enum": [ - "userGroups", + "permissions", + "origin", + "accessInfo", + "page", + "all", "ALL" ], "type": "string" }, - "type": "array" + "type": "array", + "uniqueItems": true }, "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" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put User entity", + "summary": "Get all Dashboards", "tags": [ - "Users - Entity APIs", + "Dashboards", "entities", - "user-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - } - }, - "/api/v1/entities/users/{userId}/apiTokens": { - "get": { - "operationId": "getAllEntities@ApiTokens", + }, + "post": { + "operationId": "createEntity@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "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", + "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": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" + "items": { + "enum": [ + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -54621,7 +61681,9 @@ "description": "Included meta objects", "items": { "enum": [ - "page", + "permissions", + "origin", + "accessInfo", "all", "ALL" ], @@ -54633,96 +61695,150 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "List all api tokens for a user", + "summary": "Post Dashboards", "tags": [ - "API tokens", + "Dashboards", "entities", - "api-token-controller" - ] - }, + "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}/analyticalDashboards/search": { "post": { - "operationId": "createEntity@ApiTokens", + "operationId": "searchEntities@AnalyticalDashboards", "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/JsonApiApiTokenInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "$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/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new API token for the user", + "summary": "The search endpoint (beta)", "tags": [ - "API tokens", + "Dashboards", "entities", - "api-token-controller" - ] + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/entities/users/{userId}/apiTokens/{id}": { + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { "delete": { - "operationId": "deleteEntity@ApiTokens", + "operationId": "deleteEntity@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -54730,69 +61846,33 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an API Token for a user", + "summary": "Delete a Dashboard", "tags": [ - "API tokens", + "Dashboards", "entities", - "api-token-controller" - ] + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "get": { - "operationId": "getEntity@ApiTokens", + "operationId": "getEntity@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": "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", + "name": "objectId", "required": true, "schema": { "type": "string" @@ -54800,7 +61880,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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -54808,17 +61888,48 @@ } }, { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "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", + "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" }, { - "$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=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -54827,7 +61938,9 @@ "description": "Included meta objects", "items": { "enum": [ - "page", + "permissions", + "origin", + "accessInfo", "all", "ALL" ], @@ -54844,250 +61957,408 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "List all custom application settings for a user", + "summary": "Get a Dashboard", "tags": [ - "User Settings", + "Dashboards", "entities", - "custom-user-application-setting-controller" - ] + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, - "post": { - "operationId": "createEntity@CustomUserApplicationSettings", + "patch": { + "operationId": "patchEntity@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "explode": false, + "in": "query", + "name": "include", + "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" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new custom application setting for the user", + "summary": "Patch a Dashboard", "tags": [ - "User Settings", + "Dashboards", "entities", - "custom-user-application-setting-controller" - ] - } - }, - "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { - "delete": { - "operationId": "deleteEntity@CustomUserApplicationSettings", + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, + "put": { + "operationId": "updateEntity@AnalyticalDashboards", "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 custom application setting for a user", - "tags": [ - "User Settings", - "entities", - "custom-user-application-setting-controller" - ] - }, - "get": { - "operationId": "getEntity@CustomUserApplicationSettings", - "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": "applicationName==someString;content==JsonNodeValue", + "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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "explode": false, + "in": "query", + "name": "include", + "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" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a custom application setting for a user", + "summary": "Put Dashboards", "tags": [ - "User Settings", + "Dashboards", "entities", - "custom-user-application-setting-controller" - ] - }, - "put": { - "operationId": "updateEntity@CustomUserApplicationSettings", + "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}/attributeHierarchies": { + "get": { + "operationId": "getAllEntities@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "applicationName==someString;content==JsonNodeValue", + "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,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put a custom application setting for the user", + "summary": "Get all Attribute Hierarchies", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "custom-user-application-setting-controller" - ] - } - }, - "/api/v1/entities/users/{userId}/userSettings": { - "get": { - "operationId": "getAllEntities@UserSettings", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "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": "content==JsonNodeValue;type==SettingTypeValue", + "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": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -55096,7 +62367,7 @@ "description": "Included meta objects", "items": { "enum": [ - "page", + "origin", "all", "ALL" ], @@ -55108,96 +62379,150 @@ "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": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "List all settings for a user", + "summary": "Post Attribute Hierarchies", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] - }, + "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}/attributeHierarchies/search": { "post": { - "operationId": "createEntity@UserSettings", + "operationId": "searchEntities@AttributeHierarchies", "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/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post new user settings for the user", + "summary": "The search endpoint (beta)", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] + "attribute-hierarchy-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}": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { "delete": { - "operationId": "deleteEntity@UserSettings", + "operationId": "deleteEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -55205,35 +62530,99 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a setting for a user", + "summary": "Delete an Attribute Hierarchy", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "get": { - "operationId": "getEntity@UserSettings", + "operationId": "getEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "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": { @@ -55241,59 +62630,92 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a setting for a user", + "summary": "Get an Attribute Hierarchy", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, - "put": { - "operationId": "updateEntity@UserSettings", + "patch": { + "operationId": "patchEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } } }, @@ -55304,34 +62726,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put new user settings for the user", + "summary": "Patch an Attribute Hierarchy", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] - } - }, - "/api/v1/entities/workspaces": { - "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Workspaces", + "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": [ + { + "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": { @@ -55340,7 +62781,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,attributes", "explode": false, "in": "query", "name": "include", @@ -55348,8 +62789,10 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -55357,80 +62800,93 @@ "type": "array" }, "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "config", - "permissions", - "hierarchy", - "dataModelDatasets", - "page", - "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": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entities", + "summary": "Put an Attribute Hierarchy", "tags": [ - "Workspaces - Entity APIs", + "Attribute Hierarchies", "entities", - "workspace-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": { - "description": "Space of the shared interest", - "operationId": "createEntity@Workspaces", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "get": { + "operationId": "getAllEntities@Attributes", "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;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": "parent", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -55438,8 +62894,11 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "datasets", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -55448,9 +62907,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=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -55459,10 +62936,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "page", "all", "ALL" ], @@ -55474,89 +62950,139 @@ "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Workspace entities", + "summary": "Get all Attributes", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-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": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{id}": { - "delete": { - "description": "Space of the shared interest", - "operationId": "deleteEntity@Workspaces", + "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { + "post": { + "operationId": "searchEntities@Attributes", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": { - "204": { - "$ref": "#/components/responses/Deleted" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeOutList" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Delete Workspace entity", + "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-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": [ - "MANAGE" + "VIEW" ] } - }, + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Workspaces", + "operationId": "getEntity@Attributes", "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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -55565,7 +63091,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": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -55573,8 +63099,11 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "datasets", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -55583,9 +63112,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,all", "explode": false, "in": "query", "name": "metaInclude", @@ -55594,10 +63132,8 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", "all", "ALL" ], @@ -55614,23 +63150,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entity", + "summary": "Get an Attribute", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55640,15 +63176,27 @@ } }, "patch": { - "description": "Space of the shared interest", - "operationId": "patchEntity@Workspaces", + "operationId": "patchEntity@Attributes", "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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -55657,7 +63205,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": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -55665,8 +63213,11 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "datasets", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -55680,12 +63231,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } } }, @@ -55696,23 +63247,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Workspace entity", + "summary": "Patch an Attribute (beta)", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -55720,57 +63271,54 @@ "MANAGE" ] } - }, - "put": { - "description": "Space of the shared interest", - "operationId": "updateEntity@Workspaces", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { + "post": { + "operationId": "searchEntities@AutomationResults", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "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", "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": "parent", - "explode": false, - "in": "query", - "name": "include", + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/EntitySearchBody" } } }, + "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -55778,35 +63326,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put Workspace entity", + "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Entity APIs", + "Automations", "entities", - "workspace-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": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { + "/api/v1/entities/workspaces/{workspaceId}/automations": { "get": { - "operationId": "getAllEntities@AggregatedFacts", + "operationId": "getAllEntities@Automations", "parameters": [ { "in": "path", @@ -55833,7 +63381,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -55842,7 +63390,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -55850,12 +63398,23 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -55911,23 +63470,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Aggregated Facts", + "summary": "Get all Automations", "tags": [ - "Facts", + "Automations", "entities", - "aggregated-fact-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -55935,11 +63494,125 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@Automations", + "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": "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", + "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/JsonApiAutomationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Automations", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { + "/api/v1/entities/workspaces/{workspaceId}/automations/search": { "post": { - "operationId": "searchEntities@AggregatedFacts", + "operationId": "searchEntities@Automations", "parameters": [ { "in": "path", @@ -55990,12 +63663,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, @@ -56004,9 +63677,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Facts", + "Automations", "entities", - "aggregated-fact-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56016,9 +63689,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { + "delete": { + "operationId": "deleteEntity@Automations", + "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 Automation", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } + }, "get": { - "operationId": "getEntity@AggregatedFacts", + "operationId": "getEntity@Automations", "parameters": [ { "in": "path", @@ -56038,7 +63749,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -56047,7 +63758,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -56055,12 +63766,23 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -56106,23 +63828,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Aggregated Fact", + "summary": "Get an Automation", "tags": [ - "Facts", + "Automations", "entities", - "aggregated-fact-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56130,11 +63852,229 @@ "VIEW" ] } + }, + "patch": { + "operationId": "patchEntity@Automations", + "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;notificationChannel.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "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" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch an Automation", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } + }, + "put": { + "operationId": "updateEntity@Automations", + "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;notificationChannel.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "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" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put an Automation", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes": { "get": { - "operationId": "getAllEntities@AnalyticalDashboards", + "operationId": "getAllEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -56170,7 +64110,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -56179,14 +64119,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -56218,7 +64157,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -56229,7 +64168,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "page", "all", "ALL" @@ -56247,23 +64185,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Dashboards", + "summary": "Get all Computed Attributes", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56273,7 +64211,7 @@ } }, "post": { - "operationId": "createEntity@AnalyticalDashboards", + "operationId": "createEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -56285,7 +64223,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -56294,14 +64232,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -56315,7 +64252,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -56326,7 +64263,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "all", "ALL" ], @@ -56342,12 +64278,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" } } }, @@ -56358,35 +64294,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Dashboards", + "summary": "Post Computed Attributes", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to create Computed Attributes", "permissions": [ - "ANALYZE" + "CREATE_COMPUTED_ATTRIBUTE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search": { "post": { - "operationId": "searchEntities@AnalyticalDashboards", + "operationId": "searchEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -56437,12 +64373,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } } }, @@ -56451,9 +64387,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56463,9 +64399,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}": { "delete": { - "operationId": "deleteEntity@AnalyticalDashboards", + "operationId": "deleteEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -56489,21 +64425,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Dashboard", + "summary": "Delete a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@AnalyticalDashboards", + "operationId": "getEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -56532,7 +64468,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -56541,14 +64477,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -56571,7 +64506,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -56582,7 +64517,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "all", "ALL" ], @@ -56599,23 +64533,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dashboard", + "summary": "Get a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56625,7 +64559,7 @@ } }, "patch": { - "operationId": "patchEntity@AnalyticalDashboards", + "operationId": "patchEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -56654,7 +64588,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -56663,14 +64597,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -56687,12 +64620,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } } }, @@ -56703,33 +64636,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dashboard", + "summary": "Patch a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@AnalyticalDashboards", + "operationId": "updateEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -56758,7 +64691,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -56767,14 +64700,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -56791,12 +64723,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" } } }, @@ -56807,35 +64739,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Dashboards", + "summary": "Put a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { "get": { - "operationId": "getAllEntities@AttributeHierarchies", + "operationId": "getAllEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -56862,35 +64794,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" - }, { "$ref": "#/components/parameters/page" }, @@ -56938,23 +64848,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attribute Hierarchies", + "summary": "Get all Custom Application Settings", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -56964,7 +64874,7 @@ } }, "post": { - "operationId": "createEntity@AttributeHierarchies", + "operationId": "createEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -56974,28 +64884,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,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", @@ -57023,12 +64911,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } } }, @@ -57039,35 +64927,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Attribute Hierarchies", + "summary": "Post Custom Application Settings", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { "post": { - "operationId": "searchEntities@AttributeHierarchies", + "operationId": "searchEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -57118,12 +65000,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, @@ -57132,9 +65014,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57144,9 +65026,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@AttributeHierarchies", + "operationId": "deleteEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -57170,21 +65052,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Attribute Hierarchy", + "summary": "Delete a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] }, "get": { - "operationId": "getEntity@AttributeHierarchies", + "operationId": "getEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -57204,35 +65080,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -57270,23 +65124,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute Hierarchy", + "summary": "Get a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57296,7 +65150,7 @@ } }, "patch": { - "operationId": "patchEntity@AttributeHierarchies", + "operationId": "patchEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -57316,46 +65170,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } } }, @@ -57366,33 +65198,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute Hierarchy", + "summary": "Patch a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] }, "put": { - "operationId": "updateEntity@AttributeHierarchies", + "operationId": "updateEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -57412,46 +65238,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } } }, @@ -57462,35 +65266,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Attribute Hierarchy", + "summary": "Put a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { "get": { - "operationId": "getAllEntities@Attributes", + "operationId": "getAllEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -57517,7 +65315,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": { @@ -57526,7 +65324,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", "explode": false, "in": "query", "name": "include", @@ -57534,11 +65332,9 @@ "schema": { "items": { "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -57590,39 +65386,139 @@ } ], "responses": { - "200": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Plugins", + "tags": [ + "Plugins", + "entities", + "dashboard-plugin-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@DashboardPlugins", + "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/JsonApiDashboardPluginPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attributes", + "summary": "Post Plugins", "tags": [ - "Attributes", + "Plugins", "entities", - "attribute-controller" + "dashboard-plugin-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" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { "post": { - "operationId": "searchEntities@Attributes", + "operationId": "searchEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -57673,12 +65569,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, @@ -57687,9 +65583,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Attributes", + "Plugins", "entities", - "attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57699,9 +65595,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { + "delete": { + "operationId": "deleteEntity@DashboardPlugins", + "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 Plugin", + "tags": [ + "Plugins", + "entities", + "dashboard-plugin-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, "get": { - "operationId": "getEntity@Attributes", + "operationId": "getEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -57721,7 +65655,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": { @@ -57730,7 +65664,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", "explode": false, "in": "query", "name": "include", @@ -57738,11 +65672,9 @@ "schema": { "items": { "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -57788,23 +65720,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute", + "summary": "Get a Plugin", "tags": [ - "Attributes", + "Plugins", "entities", - "attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -57814,7 +65746,7 @@ } }, "patch": { - "operationId": "patchEntity@Attributes", + "operationId": "patchEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -57834,7 +65766,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": { @@ -57843,7 +65775,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", "explode": false, "in": "query", "name": "include", @@ -57851,11 +65783,9 @@ "schema": { "items": { "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -57869,12 +65799,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } } }, @@ -57885,35 +65815,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", + "summary": "Patch a Plugin", "tags": [ - "Attributes", + "Plugins", "entities", - "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}/automationResults/search": { - "post": { - "operationId": "searchEntities@AutomationResults", + }, + "put": { + "operationId": "updateEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -57924,39 +65852,57 @@ } }, { + "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", + "explode": false, + "in": "query", + "name": "include", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -57964,35 +65910,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Put a Plugin", "tags": [ - "Automations", + "Plugins", "entities", - "automation-result-controller" + "dashboard-plugin-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" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations": { + "/api/v1/entities/workspaces/{workspaceId}/datasets": { "get": { - "operationId": "getAllEntities@Automations", + "operationId": "getAllEntities@Datasets", "parameters": [ { "in": "path", @@ -58019,7 +65965,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -58028,7 +65974,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", @@ -58036,17 +65982,12 @@ "schema": { "items": { "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", "ALL" ], "type": "string" @@ -58102,23 +66043,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations", + "summary": "Get all Datasets", "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58126,119 +66067,11 @@ "VIEW" ] } - }, - "post": { - "operationId": "createEntity@Automations", - "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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "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/JsonApiAutomationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Automations", - "tags": [ - "Automations", - "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/search": { + "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { "post": { - "operationId": "searchEntities@Automations", + "operationId": "searchEntities@Datasets", "parameters": [ { "in": "path", @@ -58289,12 +66122,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, @@ -58303,168 +66136,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Automations", - "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { - "delete": { - "operationId": "deleteEntity@Automations", - "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 Automation", - "tags": [ - "Automations", - "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } - }, - "get": { - "operationId": "getEntity@Automations", - "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;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get an Automation", - "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58472,9 +66146,11 @@ "VIEW" ] } - }, - "patch": { - "operationId": "patchEntity@Automations", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { + "get": { + "operationId": "getEntity@Datasets", "parameters": [ { "in": "path", @@ -58494,7 +66170,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -58503,7 +66179,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", @@ -58511,17 +66187,12 @@ "schema": { "items": { "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", "ALL" ], "type": "string" @@ -58529,55 +66200,71 @@ "type": "array" }, "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" - } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" } }, - "required": true - }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Automation", + "summary": "Get a Dataset", "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-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": [ - "CREATE_AUTOMATION" + "VIEW" ] } }, - "put": { - "operationId": "updateEntity@Automations", + "patch": { + "operationId": "patchEntity@Datasets", "parameters": [ { "in": "path", @@ -58597,7 +66284,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -58606,7 +66293,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", @@ -58614,17 +66301,12 @@ "schema": { "items": { "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", "ALL" ], "type": "string" @@ -58638,12 +66320,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } } }, @@ -58654,35 +66336,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Automation", + "summary": "Patch a Dataset (beta)", "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_AUTOMATION" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { "get": { - "operationId": "getAllEntities@CustomApplicationSettings", + "operationId": "getAllEntities@ExportDefinitions", "parameters": [ { "in": "path", @@ -58709,13 +66391,40 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -58763,23 +66472,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Custom Application Settings", + "summary": "Get all Export Definitions", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58789,7 +66498,7 @@ } }, "post": { - "operationId": "createEntity@CustomApplicationSettings", + "operationId": "createEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -58799,6 +66508,33 @@ "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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -58826,12 +66562,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" } } }, @@ -58842,29 +66578,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Custom Application Settings", + "summary": "Post Export Definitions", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search": { "post": { - "operationId": "searchEntities@CustomApplicationSettings", + "operationId": "searchEntities@ExportDefinitions", "parameters": [ { "in": "path", @@ -58915,12 +66657,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } } }, @@ -58929,9 +66671,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -58941,9 +66683,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}": { "delete": { - "operationId": "deleteEntity@CustomApplicationSettings", + "operationId": "deleteEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -58967,15 +66709,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Custom Application Setting", + "summary": "Delete an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "get": { - "operationId": "getEntity@CustomApplicationSettings", + "operationId": "getEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -58995,13 +66743,40 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -59039,23 +66814,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Custom Application Setting", + "summary": "Get an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59065,7 +66840,7 @@ } }, "patch": { - "operationId": "patchEntity@CustomApplicationSettings", + "operationId": "patchEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -59085,24 +66860,51 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" } } }, @@ -59113,27 +66915,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Custom Application Setting", + "summary": "Patch an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "put": { - "operationId": "updateEntity@CustomApplicationSettings", + "operationId": "updateEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -59153,24 +66961,51 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" } } }, @@ -59181,29 +67016,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Custom Application Setting", + "summary": "Put an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { + "/api/v1/entities/workspaces/{workspaceId}/facts": { "get": { - "operationId": "getAllEntities@DashboardPlugins", + "operationId": "getAllEntities@Facts", "parameters": [ { "in": "path", @@ -59230,7 +67071,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", "in": "query", "name": "filter", "schema": { @@ -59239,7 +67080,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "dataset", "explode": false, "in": "query", "name": "include", @@ -59247,9 +67088,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "datasets", + "dataset", "ALL" ], "type": "string" @@ -59278,7 +67118,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -59287,153 +67127,54 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "page", "all", "ALL" ], "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "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": "Get all Plugins", - "tags": [ - "Plugins", - "entities", - "dashboard-plugin-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "post": { - "operationId": "createEntity@DashboardPlugins", - "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/JsonApiDashboardPluginPostOptionalIdDocument" - } + }, + "type": "array", + "uniqueItems": true }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" - } - } - }, - "required": true - }, + "style": "form" + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Plugins", + "summary": "Get all Facts", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-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}/dashboardPlugins/search": { + "/api/v1/entities/workspaces/{workspaceId}/facts/search": { "post": { - "operationId": "searchEntities@DashboardPlugins", + "operationId": "searchEntities@Facts", "parameters": [ { "in": "path", @@ -59484,12 +67225,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiFactOutList" } } }, @@ -59498,9 +67239,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59510,47 +67251,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { - "delete": { - "operationId": "deleteEntity@DashboardPlugins", - "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 Plugin", - "tags": [ - "Plugins", - "entities", - "dashboard-plugin-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, + "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}": { "get": { - "operationId": "getEntity@DashboardPlugins", + "operationId": "getEntity@Facts", "parameters": [ { "in": "path", @@ -59570,7 +67273,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", "in": "query", "name": "filter", "schema": { @@ -59579,7 +67282,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "dataset", "explode": false, "in": "query", "name": "include", @@ -59587,9 +67290,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "datasets", + "dataset", "ALL" ], "type": "string" @@ -59609,7 +67311,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -59618,6 +67320,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -59635,23 +67338,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Plugin", + "summary": "Get a Fact", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -59661,7 +67364,7 @@ } }, "patch": { - "operationId": "patchEntity@DashboardPlugins", + "operationId": "patchEntity@Facts", "parameters": [ { "in": "path", @@ -59681,7 +67384,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", "in": "query", "name": "filter", "schema": { @@ -59690,7 +67393,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "dataset", "explode": false, "in": "query", "name": "include", @@ -59698,9 +67401,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "datasets", + "dataset", "ALL" ], "type": "string" @@ -59714,12 +67416,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiFactPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiFactPatchDocument" } } }, @@ -59730,33 +67432,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Plugin", + "summary": "Patch a Fact (beta)", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@DashboardPlugins", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterContexts": { + "get": { + "operationId": "getAllEntities@FilterContexts", "parameters": [ { "in": "path", @@ -59767,16 +67471,23 @@ } }, { - "in": "path", - "name": "objectId", - "required": true, + "in": "query", + "name": "origin", + "required": false, "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], "type": "string" } }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -59785,7 +67496,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -59793,9 +67504,12 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "attributes", + "datasets", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -59803,57 +67517,81 @@ "type": "array" }, "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" - } + }, + { + "$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" } }, - "required": true - }, + { + "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/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Plugin", + "summary": "Get all Filter Context", "tags": [ - "Plugins", + "Filter Context", "entities", - "dashboard-plugin-controller" + "filter-context-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}/datasets": { - "get": { - "operationId": "getAllEntities@Datasets", + }, + "post": { + "operationId": "createEntity@FilterContexts", "parameters": [ { "in": "path", @@ -59863,33 +67601,9 @@ "type": "string" } }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, { "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": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -59898,11 +67612,11 @@ "items": { "enum": [ "attributes", - "facts", - "aggregatedFacts", "datasets", - "workspaceDataFilters", - "references", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -59911,27 +67625,9 @@ }, "style": "form" }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -59941,7 +67637,6 @@ "items": { "enum": [ "origin", - "page", "all", "ALL" ], @@ -59953,40 +67648,55 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Datasets", + "summary": "Post Filter Context", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-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" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { + "/api/v1/entities/workspaces/{workspaceId}/filterContexts/search": { "post": { - "operationId": "searchEntities@Datasets", + "operationId": "searchEntities@FilterContexts", "parameters": [ { "in": "path", @@ -60037,12 +67747,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } } }, @@ -60051,9 +67761,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60063,9 +67773,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}": { + "delete": { + "operationId": "deleteEntity@FilterContexts", + "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 Filter Context", + "tags": [ + "Filter Context", + "entities", + "filter-context-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, "get": { - "operationId": "getEntity@Datasets", + "operationId": "getEntity@FilterContexts", "parameters": [ { "in": "path", @@ -60094,7 +67842,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": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -60103,11 +67851,11 @@ "items": { "enum": [ "attributes", - "facts", - "aggregatedFacts", "datasets", - "workspaceDataFilters", - "references", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -60153,23 +67901,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dataset", + "summary": "Get a Filter Context", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60179,7 +67927,7 @@ } }, "patch": { - "operationId": "patchEntity@Datasets", + "operationId": "patchEntity@FilterContexts", "parameters": [ { "in": "path", @@ -60208,7 +67956,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": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -60217,11 +67965,109 @@ "items": { "enum": [ "attributes", + "datasets", + "labels", + "computedAttributes", + "metrics", "facts", - "aggregatedFacts", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Filter Context", + "tags": [ + "Filter Context", + "entities", + "filter-context-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, + "put": { + "operationId": "updateEntity@FilterContexts", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "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,datasets,labels,computedAttributes,metrics,facts", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", "datasets", - "workspaceDataFilters", - "references", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -60235,12 +68081,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterContextInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterContextInDocument" } } }, @@ -60251,35 +68097,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", + "summary": "Put a Filter Context", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { + "/api/v1/entities/workspaces/{workspaceId}/filterViews": { "get": { - "operationId": "getAllEntities@ExportDefinitions", + "operationId": "getAllEntities@FilterViews", "parameters": [ { "in": "path", @@ -60306,7 +68152,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -60315,7 +68161,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -60323,15 +68169,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -60360,7 +68201,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -60369,7 +68210,6 @@ "description": "Included meta objects", "items": { "enum": [ - "origin", "page", "all", "ALL" @@ -60387,23 +68227,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Export Definitions", + "summary": "Get all Filter views", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60413,7 +68253,7 @@ } }, "post": { - "operationId": "createEntity@ExportDefinitions", + "operationId": "createEntity@FilterViews", "parameters": [ { "in": "path", @@ -60425,7 +68265,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -60433,15 +68273,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -60449,40 +68284,18 @@ "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/JsonApiExportDefinitionPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } } }, @@ -60493,35 +68306,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Export Definitions", + "summary": "Post Filter views", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search": { + "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { "post": { - "operationId": "searchEntities@ExportDefinitions", + "operationId": "searchEntities@FilterViews", "parameters": [ { "in": "path", @@ -60572,12 +68385,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } } }, @@ -60586,9 +68399,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60598,9 +68411,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { "delete": { - "operationId": "deleteEntity@ExportDefinitions", + "operationId": "deleteEntity@FilterViews", "parameters": [ { "in": "path", @@ -60624,21 +68437,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Export Definition", + "summary": "Delete Filter view", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } }, "get": { - "operationId": "getEntity@ExportDefinitions", + "operationId": "getEntity@FilterViews", "parameters": [ { "in": "path", @@ -60658,7 +68471,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -60667,7 +68480,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -60675,15 +68488,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -60700,28 +68508,6 @@ "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": { @@ -60729,23 +68515,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Export Definition", + "summary": "Get Filter view", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -60755,7 +68541,7 @@ } }, "patch": { - "operationId": "patchEntity@ExportDefinitions", + "operationId": "patchEntity@FilterViews", "parameters": [ { "in": "path", @@ -60775,7 +68561,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -60784,7 +68570,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -60792,15 +68578,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -60814,12 +68595,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" } } }, @@ -60830,33 +68611,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Export Definition", + "summary": "Patch Filter view", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } }, "put": { - "operationId": "updateEntity@ExportDefinitions", + "operationId": "updateEntity@FilterViews", "parameters": [ { "in": "path", @@ -60876,7 +68657,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -60885,7 +68666,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -60893,15 +68674,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -60915,12 +68691,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } } }, @@ -60931,35 +68707,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Export Definition", + "summary": "Put Filter views", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/facts": { + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars": { "get": { - "operationId": "getAllEntities@Facts", + "operationId": "getAllEntities@FiscalCalendars", "parameters": [ { "in": "path", @@ -60986,7 +68762,185 @@ }, { "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", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Fiscal Calendars", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}": { + "get": { + "operationId": "getEntity@FiscalCalendars", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Fiscal Calendar", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { + "get": { + "operationId": "getAllEntities@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -60995,7 +68949,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", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -61003,8 +68957,10 @@ "schema": { "items": { "enum": [ - "datasets", - "dataset", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -61056,39 +69012,140 @@ } ], "responses": { - "200": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Knowledge Recommendations", + "tags": [ + "Knowledge Recommendations", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Facts", + "summary": "Post Knowledge Recommendations", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-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}/facts/search": { + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { "post": { - "operationId": "searchEntities@Facts", + "operationId": "searchEntities@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -61139,12 +69196,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } } }, @@ -61153,9 +69210,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61165,9 +69222,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "delete": { + "operationId": "deleteEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Knowledge Recommendation", + "tags": [ + "Knowledge Recommendations", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Facts", + "operationId": "getEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -61187,7 +69282,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", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -61196,7 +69291,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", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -61204,8 +69299,10 @@ "schema": { "items": { "enum": [ - "datasets", - "dataset", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -61251,23 +69348,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Fact", + "summary": "Get a Knowledge Recommendation", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61277,7 +69374,7 @@ } }, "patch": { - "operationId": "patchEntity@Facts", + "operationId": "patchEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -61297,7 +69394,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", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -61306,7 +69403,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", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -61314,8 +69411,10 @@ "schema": { "items": { "enum": [ - "datasets", - "dataset", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -61329,12 +69428,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactPatchDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactPatchDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } } }, @@ -61345,23 +69444,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Fact (beta)", + "summary": "Patch a Knowledge Recommendation", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -61369,11 +69468,9 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts": { - "get": { - "operationId": "getAllEntities@FilterContexts", + }, + "put": { + "operationId": "updateEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -61384,23 +69481,16 @@ } }, { - "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" } }, { "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": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -61409,7 +69499,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,datasets,labels", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -61417,9 +69507,10 @@ "schema": { "items": { "enum": [ - "attributes", - "datasets", - "labels", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -61427,81 +69518,57 @@ "type": "array" }, "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Filter Context", + "summary": "Put a Knowledge Recommendation", "tags": [ - "Filter Context", + "Knowledge Recommendations", "entities", - "filter-context-controller" + "knowledge-recommendation-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" ] } - }, - "post": { - "operationId": "createEntity@FilterContexts", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels": { + "get": { + "operationId": "getAllEntities@Labels", "parameters": [ { "in": "path", @@ -61511,9 +69578,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;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", + "example": "attribute", "explode": false, "in": "query", "name": "include", @@ -61522,8 +69613,7 @@ "items": { "enum": [ "attributes", - "datasets", - "labels", + "attribute", "ALL" ], "type": "string" @@ -61532,9 +69622,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=origin,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -61543,7 +69651,9 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", + "page", "all", "ALL" ], @@ -61555,55 +69665,40 @@ "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Filter Context", + "summary": "Get all Labels", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-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}/filterContexts/search": { + "/api/v1/entities/workspaces/{workspaceId}/labels/search": { "post": { - "operationId": "searchEntities@FilterContexts", + "operationId": "searchEntities@Labels", "parameters": [ { "in": "path", @@ -61654,12 +69749,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiLabelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiLabelOutList" } } }, @@ -61668,9 +69763,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61680,47 +69775,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}": { - "delete": { - "operationId": "deleteEntity@FilterContexts", - "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 Filter Context", - "tags": [ - "Filter Context", - "entities", - "filter-context-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, + "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { "get": { - "operationId": "getEntity@FilterContexts", + "operationId": "getEntity@Labels", "parameters": [ { "in": "path", @@ -61740,7 +69797,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": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { @@ -61749,7 +69806,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,datasets,labels", + "example": "attribute", "explode": false, "in": "query", "name": "include", @@ -61758,8 +69815,7 @@ "items": { "enum": [ "attributes", - "datasets", - "labels", + "attribute", "ALL" ], "type": "string" @@ -61779,7 +69835,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -61788,6 +69844,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -61805,23 +69862,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Filter Context", + "summary": "Get a Label", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -61831,102 +69888,7 @@ } }, "patch": { - "operationId": "patchEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "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,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Patch a Filter Context", - "tags": [ - "Filter Context", - "entities", - "filter-context-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, - "put": { - "operationId": "updateEntity@FilterContexts", + "operationId": "patchEntity@Labels", "parameters": [ { "in": "path", @@ -61946,7 +69908,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": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { @@ -61955,7 +69917,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,datasets,labels", + "example": "attribute", "explode": false, "in": "query", "name": "include", @@ -61964,8 +69926,7 @@ "items": { "enum": [ "attributes", - "datasets", - "labels", + "attribute", "ALL" ], "type": "string" @@ -61979,12 +69940,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextInDocument" + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextInDocument" + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" } } }, @@ -61995,35 +69956,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Filter Context", + "summary": "Patch a Label (beta)", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { "get": { - "operationId": "getAllEntities@FilterViews", + "operationId": "getAllEntities@MemoryItems", "parameters": [ { "in": "path", @@ -62050,7 +70011,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -62059,7 +70020,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -62067,10 +70028,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -62099,7 +70059,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -62108,6 +70068,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -62125,23 +70086,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Filter views", + "summary": "Get all Memory Items", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62151,7 +70112,7 @@ } }, "post": { - "operationId": "createEntity@FilterViews", + "operationId": "createEntity@MemoryItems", "parameters": [ { "in": "path", @@ -62163,7 +70124,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -62171,10 +70132,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -62182,18 +70142,40 @@ "type": "array" }, "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } } }, @@ -62204,35 +70186,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Filter views", + "summary": "Post Memory Items", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { "post": { - "operationId": "searchEntities@FilterViews", + "operationId": "searchEntities@MemoryItems", "parameters": [ { "in": "path", @@ -62283,12 +70265,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, @@ -62297,9 +70279,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62309,9 +70291,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { "delete": { - "operationId": "deleteEntity@FilterViews", + "operationId": "deleteEntity@MemoryItems", "parameters": [ { "in": "path", @@ -62335,21 +70317,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Filter view", + "summary": "Delete a Memory Item", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@FilterViews", + "operationId": "getEntity@MemoryItems", "parameters": [ { "in": "path", @@ -62369,7 +70351,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -62378,7 +70360,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -62386,10 +70368,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -62406,6 +70387,28 @@ "default": false, "type": "boolean" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -62413,23 +70416,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Filter view", + "summary": "Get a Memory Item", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62439,7 +70442,7 @@ } }, "patch": { - "operationId": "patchEntity@FilterViews", + "operationId": "patchEntity@MemoryItems", "parameters": [ { "in": "path", @@ -62459,7 +70462,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -62468,7 +70471,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -62476,10 +70479,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -62493,12 +70495,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } } }, @@ -62509,33 +70511,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Filter view", + "summary": "Patch a Memory Item", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@FilterViews", + "operationId": "updateEntity@MemoryItems", "parameters": [ { "in": "path", @@ -62555,7 +70557,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -62564,7 +70566,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -62572,10 +70574,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -62589,12 +70590,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } } }, @@ -62605,213 +70606,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Put Filter views", - "tags": [ - "Filter Views", - "entities", - "filter-view-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", - "permissions": [ - "CREATE_FILTER_VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars": { - "get": { - "operationId": "getAllEntities@FiscalCalendars", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Fiscal Calendars", - "tags": [ - "Fiscal Calendars", - "entities", - "fiscal-calendar-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}": { - "get": { - "operationId": "getEntity@FiscalCalendars", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Fiscal Calendar", + "summary": "Put a Memory Item", "tags": [ - "Fiscal Calendars", + "Memory Items", "entities", - "fiscal-calendar-controller" + "memory-item-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}/knowledgeRecommendations": { + "/api/v1/entities/workspaces/{workspaceId}/metrics": { "get": { - "operationId": "getAllEntities@KnowledgeRecommendations", + "operationId": "getAllEntities@Metrics", "parameters": [ { "in": "path", @@ -62838,7 +70661,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -62847,7 +70670,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -62855,10 +70678,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -62887,7 +70717,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -62896,6 +70726,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "page", "all", @@ -62914,23 +70745,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Knowledge Recommendations", + "summary": "Get all Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -62940,7 +70771,7 @@ } }, "post": { - "operationId": "createEntity@KnowledgeRecommendations", + "operationId": "createEntity@Metrics", "parameters": [ { "in": "path", @@ -62952,7 +70783,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -62960,10 +70791,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -62974,7 +70812,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -62983,6 +70821,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -62999,12 +70838,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } } }, @@ -63015,35 +70854,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Knowledge Recommendations", + "summary": "Post Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to create Metrics", "permissions": [ - "MANAGE" + "CREATE_METRIC" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { "post": { - "operationId": "searchEntities@KnowledgeRecommendations", + "operationId": "searchEntities@Metrics", "parameters": [ { "in": "path", @@ -63094,12 +70933,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, @@ -63108,9 +70947,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63120,9 +70959,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { "delete": { - "operationId": "deleteEntity@KnowledgeRecommendations", + "operationId": "deleteEntity@Metrics", "parameters": [ { "in": "path", @@ -63146,11 +70985,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Knowledge Recommendation", + "summary": "Delete a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -63160,7 +70999,7 @@ } }, "get": { - "operationId": "getEntity@KnowledgeRecommendations", + "operationId": "getEntity@Metrics", "parameters": [ { "in": "path", @@ -63180,7 +71019,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63189,7 +71028,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -63197,10 +71036,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -63220,7 +71066,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -63229,6 +71075,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -63246,23 +71093,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Knowledge Recommendation", + "summary": "Get a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63272,7 +71119,7 @@ } }, "patch": { - "operationId": "patchEntity@KnowledgeRecommendations", + "operationId": "patchEntity@Metrics", "parameters": [ { "in": "path", @@ -63292,7 +71139,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63301,7 +71148,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -63309,10 +71156,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -63326,12 +71180,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } } }, @@ -63342,23 +71196,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Knowledge Recommendation", + "summary": "Patch a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -63368,7 +71222,7 @@ } }, "put": { - "operationId": "updateEntity@KnowledgeRecommendations", + "operationId": "updateEntity@Metrics", "parameters": [ { "in": "path", @@ -63388,7 +71242,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63397,7 +71251,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -63405,10 +71259,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -63422,12 +71283,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, @@ -63438,23 +71299,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Knowledge Recommendation", + "summary": "Put a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -63464,9 +71325,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels": { + "/api/v1/entities/workspaces/{workspaceId}/parameters": { "get": { - "operationId": "getAllEntities@Labels", + "operationId": "getAllEntities@Parameters", "parameters": [ { "in": "path", @@ -63493,7 +71354,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63502,7 +71363,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -63510,8 +71371,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -63567,23 +71429,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Labels", + "summary": "Get all Parameters", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63591,11 +71453,111 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Parameters", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/search": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { "post": { - "operationId": "searchEntities@Labels", + "operationId": "searchEntities@Parameters", "parameters": [ { "in": "path", @@ -63646,12 +71608,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, @@ -63660,9 +71622,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63672,9 +71634,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "delete": { + "operationId": "deleteEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Labels", + "operationId": "getEntity@Parameters", "parameters": [ { "in": "path", @@ -63694,7 +71694,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63703,7 +71703,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -63711,8 +71711,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -63758,23 +71759,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Label", + "summary": "Get a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -63784,7 +71785,7 @@ } }, "patch": { - "operationId": "patchEntity@Labels", + "operationId": "patchEntity@Parameters", "parameters": [ { "in": "path", @@ -63804,7 +71805,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -63813,7 +71814,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -63821,8 +71822,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -63836,12 +71838,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } } }, @@ -63852,23 +71854,118 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Label (beta)", + "summary": "Patch a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Parameters", + "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", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -63878,9 +71975,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { + "/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts": { "get": { - "operationId": "getAllEntities@MemoryItems", + "operationId": "getAllEntities@ReportPageLayouts", "parameters": [ { "in": "path", @@ -63982,23 +72079,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Memory Items", + "summary": "Get all Report Page Layouts", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64008,7 +72105,7 @@ } }, "post": { - "operationId": "createEntity@MemoryItems", + "operationId": "createEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -64066,12 +72163,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalIdDocument" } } }, @@ -64082,23 +72179,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Memory Items", + "summary": "Post Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -64108,88 +72205,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { - "post": { - "operationId": "searchEntities@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "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/JsonApiMemoryItemOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "AI", - "entities", - "memory-item-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}": { "delete": { - "operationId": "deleteEntity@MemoryItems", + "operationId": "deleteEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -64213,11 +72231,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Memory Item", + "summary": "Delete a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -64227,7 +72245,7 @@ } }, "get": { - "operationId": "getEntity@MemoryItems", + "operationId": "getEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -64312,23 +72330,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Memory Item", + "summary": "Get a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64338,7 +72356,7 @@ } }, "patch": { - "operationId": "patchEntity@MemoryItems", + "operationId": "patchEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -64391,12 +72409,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatchDocument" } } }, @@ -64407,23 +72425,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Memory Item", + "summary": "Patch a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -64433,7 +72451,7 @@ } }, "put": { - "operationId": "updateEntity@MemoryItems", + "operationId": "updateEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -64486,12 +72504,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutInDocument" } } }, @@ -64502,23 +72520,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Memory Item", + "summary": "Put a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -64528,9 +72546,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics": { + "/api/v1/entities/workspaces/{workspaceId}/reportTemplates": { "get": { - "operationId": "getAllEntities@Metrics", + "operationId": "getAllEntities@ReportTemplates", "parameters": [ { "in": "path", @@ -64566,7 +72584,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64575,15 +72593,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64639,23 +72650,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiReportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiReportTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Metrics", + "summary": "Get all Report Templates", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -64665,7 +72676,7 @@ } }, "post": { - "operationId": "createEntity@Metrics", + "operationId": "createEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -64677,7 +72688,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64686,15 +72697,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64730,12 +72734,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalIdDocument" } } }, @@ -64746,114 +72750,35 @@ "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" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-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}/reportTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@Metrics", + "operationId": "deleteEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -64877,11 +72802,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Metric", + "summary": "Delete a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -64891,7 +72816,7 @@ } }, "get": { - "operationId": "getEntity@Metrics", + "operationId": "getEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -64920,7 +72845,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -64929,15 +72854,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -64983,23 +72901,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Metric", + "summary": "Get a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65009,7 +72927,7 @@ } }, "patch": { - "operationId": "patchEntity@Metrics", + "operationId": "patchEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -65038,7 +72956,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -65047,15 +72965,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -65069,12 +72980,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePatchDocument" } } }, @@ -65085,23 +72996,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Metric", + "summary": "Patch a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -65111,7 +73022,7 @@ } }, "put": { - "operationId": "updateEntity@Metrics", + "operationId": "updateEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -65140,7 +73051,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -65149,15 +73060,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -65171,12 +73075,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateInDocument" } } }, @@ -65187,23 +73091,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Metric", + "summary": "Put a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -65213,9 +73117,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters": { + "/api/v1/entities/workspaces/{workspaceId}/reports": { "get": { - "operationId": "getAllEntities@Parameters", + "operationId": "getAllEntities@Reports", "parameters": [ { "in": "path", @@ -65317,23 +73221,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiReportOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiReportOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Parameters", + "summary": "Get all Reports", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65343,7 +73247,7 @@ } }, "post": { - "operationId": "createEntity@Parameters", + "operationId": "createEntity@Reports", "parameters": [ { "in": "path", @@ -65401,12 +73305,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPostOptionalIdDocument" } } }, @@ -65417,23 +73321,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Parameters", + "summary": "Post Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -65443,88 +73347,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { - "post": { - "operationId": "searchEntities@Parameters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } - }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Parameters", - "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}": { "delete": { - "operationId": "deleteEntity@Parameters", + "operationId": "deleteEntity@Reports", "parameters": [ { "in": "path", @@ -65548,11 +73373,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Parameter", + "summary": "Delete a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -65562,7 +73387,7 @@ } }, "get": { - "operationId": "getEntity@Parameters", + "operationId": "getEntity@Reports", "parameters": [ { "in": "path", @@ -65647,23 +73472,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Parameter", + "summary": "Get a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -65673,7 +73498,7 @@ } }, "patch": { - "operationId": "patchEntity@Parameters", + "operationId": "patchEntity@Reports", "parameters": [ { "in": "path", @@ -65726,12 +73551,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPatchDocument" } } }, @@ -65742,23 +73567,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Parameter", + "summary": "Patch a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -65768,7 +73593,7 @@ } }, "put": { - "operationId": "updateEntity@Parameters", + "operationId": "updateEntity@Reports", "parameters": [ { "in": "path", @@ -65821,12 +73646,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiReportInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiReportInDocument" } } }, @@ -65837,23 +73662,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Parameter", + "summary": "Put a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -65901,7 +73726,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -65914,6 +73739,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -66012,7 +73838,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -66025,6 +73851,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -66255,7 +74082,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -66268,6 +74095,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -66373,7 +74201,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -66386,6 +74214,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -66475,7 +74304,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -66488,6 +74317,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -66586,7 +74416,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -66600,6 +74430,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -66632,7 +74463,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -66641,6 +74472,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "page", "all", @@ -66697,7 +74529,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -66711,6 +74543,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -66725,7 +74558,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -66734,6 +74567,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -66940,7 +74774,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -66954,6 +74788,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -66977,7 +74812,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -66986,6 +74821,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -67058,7 +74894,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -67072,6 +74908,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -67160,7 +74997,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -67174,6 +75011,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", diff --git a/schemas/gooddata-automation-client.json b/schemas/gooddata-automation-client.json index 8eb3a2e56..f118620ce 100644 --- a/schemas/gooddata-automation-client.json +++ b/schemas/gooddata-automation-client.json @@ -127,7 +127,6 @@ "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", "example": "2012-05", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" }, "granularity": { @@ -184,7 +183,6 @@ "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", "example": "2012-08", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" } }, @@ -360,6 +358,7 @@ "enum": [ "analyticalDashboard", "attribute", + "computedAttribute", "dashboardPlugin", "dataset", "fact", @@ -429,7 +428,8 @@ "attribute", "label", "fact", - "metric" + "metric", + "computedAttribute" ], "type": "string" } @@ -486,7 +486,8 @@ }, "type": { "enum": [ - "label" + "label", + "computedAttribute" ], "type": "string" } @@ -1042,6 +1043,9 @@ ], "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", @@ -1427,6 +1431,413 @@ ], "type": "object" }, + "ConditionalFormatting": { + "description": "Conditional formatting for a table, with one entry per formatted column.", + "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" + }, + "ConditionalFormattingAbsoluteDateValue": { + "allOf": [ + { + "properties": { + "from": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "absoluteDate" + ], + "type": "string" + }, + "to": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A fixed, inclusive date period.", + "required": [ + "from", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingAttributeTarget": { + "allOf": [ + { + "properties": { + "attributeIdentifier": { + "example": "23990482d9d04e62a9c564a29be804f8", + "type": "string" + }, + "kind": { + "description": "The target kind.", + "enum": [ + "attribute" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "An attribute column, addressed by its bucket item local identifier.", + "required": [ + "attributeIdentifier", + "kind" + ], + "type": "object" + }, + "ConditionalFormattingCondition": { + "description": "A condition and the formatting applied to cells matching it.", + "properties": { + "format": { + "$ref": "#/components/schemas/ConditionalFormattingFormat" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "d0538854-aac3-4fc6-9603-61f49bab6aa3", + "type": "string" + }, + "operator": { + "description": "How a condition compares the cell value against its value.", + "enum": [ + "ALL", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN", + "LESS_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "BETWEEN", + "NOT_BETWEEN", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "ENDS_WITH", + "NOT_ENDS_WITH", + "IS_EMPTY", + "IS_NOT_EMPTY" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingValue" + } + }, + "required": [ + "format", + "operator", + "value" + ], + "type": "object" + }, + "ConditionalFormattingFormat": { + "description": "Visual formatting applied to a matching cell.", + "properties": { + "backgroundColor": { + "description": "Background color as a hex triplet.", + "example": "#3DB36B", + "type": "string" + }, + "color": { + "description": "Text color as a hex triplet.", + "example": "#E54D40", + "type": "string" + }, + "scope": { + "description": "Whether the formatting applies to the matching cell only, or to its whole row.", + "enum": [ + "cell", + "row" + ], + "type": "string" + } + }, + "required": [ + "scope" + ], + "type": "object" + }, + "ConditionalFormattingLiteral": { + "description": "A string or a number, serialized in whichever form it was authored.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "type": "object" + }, + "ConditionalFormattingLiteralRangeValue": { + "allOf": [ + { + "properties": { + "from": { + "format": "double", + "type": "number" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "literalRange" + ], + "type": "string" + }, + "to": { + "format": "double", + "type": "number" + } + }, + "type": "object" + } + ], + "description": "An inclusive numeric range.", + "required": [ + "from", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingLiteralValue": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "literal" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingLiteral" + } + }, + "type": "object" + } + ], + "description": "A single value compared against the cell value.", + "required": [ + "kind", + "value" + ], + "type": "object" + }, + "ConditionalFormattingMeasureTarget": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The target kind.", + "enum": [ + "measure" + ], + "type": "string" + }, + "measureIdentifier": { + "example": "8cd55fe5748b48d7820ae9ee18e58011", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A measure column, addressed by its bucket item local identifier.", + "required": [ + "kind", + "measureIdentifier" + ], + "type": "object" + }, + "ConditionalFormattingNoneValue": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "No value; used by operators that take none.", + "required": [ + "kind" + ], + "type": "object" + }, + "ConditionalFormattingRelativeDateValue": { + "allOf": [ + { + "properties": { + "from": { + "description": "Offset in periods; 0 is the current period, negative is the past.", + "example": -29, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Granularity the offsets are counted in.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "relativeDate" + ], + "type": "string" + }, + "to": { + "description": "Offset in periods, not lower than `from`.", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "description": "A date period relative to the moment of evaluation, resolved at render time.", + "required": [ + "from", + "granularity", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingRule": { + "description": "Conditions applied to a single column.", + "properties": { + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "bb955b38-a9e6-45f5-b068-155cb7ce509a", + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/ConditionalFormattingTarget" + } + }, + "required": [ + "conditions", + "target" + ], + "type": "object" + }, + "ConditionalFormattingTarget": { + "description": "Column a rule formats. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingAttributeTarget" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingMeasureTarget" + } + ], + "type": "object" + }, + "ConditionalFormattingValue": { + "description": "Value a condition compares against. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingNoneValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralRangeValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingAbsoluteDateValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingRelativeDateValue" + } + ], + "type": "object" + }, "CustomLabel": { "description": "Custom label object override.", "properties": { @@ -2286,6 +2697,7 @@ "aggregatedFact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "exportDefinition", @@ -2301,6 +2713,9 @@ "workspaceDataFilter", "workspaceDataFilterSetting", "filterView", + "reportPageLayout", + "reportTemplate", + "report", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -2750,6 +3165,9 @@ }, "value": { "type": "string" + }, + "valueTitle": { + "type": "string" } }, "required": [ @@ -2851,6 +3269,11 @@ "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": [ @@ -3818,6 +4241,9 @@ "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ConditionalFormatting" + }, "customOverride": { "$ref": "#/components/schemas/CustomOverride" }, diff --git a/schemas/gooddata-export-client.json b/schemas/gooddata-export-client.json index 559faacf7..b6016cc69 100644 --- a/schemas/gooddata-export-client.json +++ b/schemas/gooddata-export-client.json @@ -127,7 +127,6 @@ "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", "example": "2012-05", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" }, "granularity": { @@ -184,7 +183,6 @@ "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", "example": "2012-08", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" } }, @@ -256,6 +254,7 @@ "enum": [ "analyticalDashboard", "attribute", + "computedAttribute", "dashboardPlugin", "dataset", "fact", @@ -325,7 +324,8 @@ "attribute", "label", "fact", - "metric" + "metric", + "computedAttribute" ], "type": "string" } @@ -382,7 +382,8 @@ }, "type": { "enum": [ - "label" + "label", + "computedAttribute" ], "type": "string" } @@ -887,6 +888,413 @@ ], "type": "object" }, + "ConditionalFormatting": { + "description": "Conditional formatting for a table, with one entry per formatted column.", + "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" + }, + "ConditionalFormattingAbsoluteDateValue": { + "allOf": [ + { + "properties": { + "from": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "absoluteDate" + ], + "type": "string" + }, + "to": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A fixed, inclusive date period.", + "required": [ + "from", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingAttributeTarget": { + "allOf": [ + { + "properties": { + "attributeIdentifier": { + "example": "23990482d9d04e62a9c564a29be804f8", + "type": "string" + }, + "kind": { + "description": "The target kind.", + "enum": [ + "attribute" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "An attribute column, addressed by its bucket item local identifier.", + "required": [ + "attributeIdentifier", + "kind" + ], + "type": "object" + }, + "ConditionalFormattingCondition": { + "description": "A condition and the formatting applied to cells matching it.", + "properties": { + "format": { + "$ref": "#/components/schemas/ConditionalFormattingFormat" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "d0538854-aac3-4fc6-9603-61f49bab6aa3", + "type": "string" + }, + "operator": { + "description": "How a condition compares the cell value against its value.", + "enum": [ + "ALL", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN", + "LESS_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "BETWEEN", + "NOT_BETWEEN", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "ENDS_WITH", + "NOT_ENDS_WITH", + "IS_EMPTY", + "IS_NOT_EMPTY" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingValue" + } + }, + "required": [ + "format", + "operator", + "value" + ], + "type": "object" + }, + "ConditionalFormattingFormat": { + "description": "Visual formatting applied to a matching cell.", + "properties": { + "backgroundColor": { + "description": "Background color as a hex triplet.", + "example": "#3DB36B", + "type": "string" + }, + "color": { + "description": "Text color as a hex triplet.", + "example": "#E54D40", + "type": "string" + }, + "scope": { + "description": "Whether the formatting applies to the matching cell only, or to its whole row.", + "enum": [ + "cell", + "row" + ], + "type": "string" + } + }, + "required": [ + "scope" + ], + "type": "object" + }, + "ConditionalFormattingLiteral": { + "description": "A string or a number, serialized in whichever form it was authored.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "type": "object" + }, + "ConditionalFormattingLiteralRangeValue": { + "allOf": [ + { + "properties": { + "from": { + "format": "double", + "type": "number" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "literalRange" + ], + "type": "string" + }, + "to": { + "format": "double", + "type": "number" + } + }, + "type": "object" + } + ], + "description": "An inclusive numeric range.", + "required": [ + "from", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingLiteralValue": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "literal" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingLiteral" + } + }, + "type": "object" + } + ], + "description": "A single value compared against the cell value.", + "required": [ + "kind", + "value" + ], + "type": "object" + }, + "ConditionalFormattingMeasureTarget": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The target kind.", + "enum": [ + "measure" + ], + "type": "string" + }, + "measureIdentifier": { + "example": "8cd55fe5748b48d7820ae9ee18e58011", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "A measure column, addressed by its bucket item local identifier.", + "required": [ + "kind", + "measureIdentifier" + ], + "type": "object" + }, + "ConditionalFormattingNoneValue": { + "allOf": [ + { + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "type": "object" + } + ], + "description": "No value; used by operators that take none.", + "required": [ + "kind" + ], + "type": "object" + }, + "ConditionalFormattingRelativeDateValue": { + "allOf": [ + { + "properties": { + "from": { + "description": "Offset in periods; 0 is the current period, negative is the past.", + "example": -29, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Granularity the offsets are counted in.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "relativeDate" + ], + "type": "string" + }, + "to": { + "description": "Offset in periods, not lower than `from`.", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "type": "object" + } + ], + "description": "A date period relative to the moment of evaluation, resolved at render time.", + "required": [ + "from", + "granularity", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingRule": { + "description": "Conditions applied to a single column.", + "properties": { + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "bb955b38-a9e6-45f5-b068-155cb7ce509a", + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/ConditionalFormattingTarget" + } + }, + "required": [ + "conditions", + "target" + ], + "type": "object" + }, + "ConditionalFormattingTarget": { + "description": "Column a rule formats. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingAttributeTarget" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingMeasureTarget" + } + ], + "type": "object" + }, + "ConditionalFormattingValue": { + "description": "Value a condition compares against. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingNoneValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralRangeValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingAbsoluteDateValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingRelativeDateValue" + } + ], + "type": "object" + }, "CustomLabel": { "description": "Custom label object override.", "properties": { @@ -1602,6 +2010,7 @@ "aggregatedFact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "exportDefinition", @@ -1617,6 +2026,9 @@ "workspaceDataFilter", "workspaceDataFilterSetting", "filterView", + "reportPageLayout", + "reportTemplate", + "report", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -1960,6 +2372,11 @@ "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": [ @@ -2564,6 +2981,44 @@ ], "type": "object" }, + "ReportExportRequest": { + "description": "Export request object describing the export properties and metadata for report exports.", + "properties": { + "fileName": { + "description": "File name to be used for retrieving the pdf document.", + "example": "filename", + "type": "string" + }, + "format": { + "description": "Requested resulting file type.", + "enum": [ + "PDF" + ], + "example": "PDF", + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/JsonNode" + }, + "reportId": { + "description": "Report identifier", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + } + }, + "required": [ + "fileName", + "format", + "reportId" + ], + "type": "object" + }, "Settings": { "description": "Additional settings.", "properties": { @@ -2799,6 +3254,9 @@ "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ConditionalFormatting" + }, "customOverride": { "$ref": "#/components/schemas/CustomOverride" }, @@ -2979,6 +3437,15 @@ "schema": { "type": "string" } + }, + { + "in": "header", + "name": "X-Gdc-Debug", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { @@ -3303,6 +3770,209 @@ } } }, + "/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.", + "operationId": "createReportExport", + "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": "Report export request created successfully." + } + }, + "summary": "(EXPERIMENTAL) Create report export request", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to execute report export.", + "permissions": [ + "EXPORT_PDF" + ] + } + } + }, + "/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.", + "operationId": "getReportExport", + "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 files", + "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/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.", + "operationId": "getReportExportMetadata", + "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 metadata context", + "tags": [ + "Report export", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/export/slides": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.", diff --git a/schemas/gooddata-metadata-client.json b/schemas/gooddata-metadata-client.json index 20cbb4890..6b3ec2a7d 100644 --- a/schemas/gooddata-metadata-client.json +++ b/schemas/gooddata-metadata-client.json @@ -172,7 +172,6 @@ "description": "Start of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the start.", "example": "2012-05", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" }, "granularity": { @@ -229,7 +228,6 @@ "description": "End of the range (including), in the format matching 'granularity'. If omitted, the range is unbounded at the end.", "example": "2012-08", "nullable": true, - "pattern": "^((?:\\d{4})|(?:\\d{4}-[1-4])|(?:\\d{4}-(0[1-9]|1[0-2]))|(?:\\d{4}-(0[1-9]|[1-4]\\d|5[0-3]))|(?:\\d{4}-\\d{2}-\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,3}|[1-7]\\d{4}|8[0-5]\\d{3}|86[0-3]\\d{2})|(?:[0-9]|[1-5]\\d)|(?:[0-9]|[1-9]\\d{1,2}|1[0-3]\\d{2}|14[0-3]\\d)|(?:[0-9]|1\\d|2[0-3])|(?:[0-6])|(?:[1-9]|[12]\\d|3[01])|(?:[1-9]|[1-8]\\d|9[0-2])|(?:[1-9]|[1-9]\\d|[12]\\d\\d|3[0-5]\\d|36[0-6])|(?:[1-9]|[1-4]\\d|5[0-3])|(?:[1-9]|1[0-2])|(?:[1-4]))$", "type": "string" } }, @@ -301,6 +299,7 @@ "enum": [ "analyticalDashboard", "attribute", + "computedAttribute", "dashboardPlugin", "dataset", "fact", @@ -370,7 +369,8 @@ "attribute", "label", "fact", - "metric" + "metric", + "computedAttribute" ], "type": "string" } @@ -427,7 +427,8 @@ }, "type": { "enum": [ - "label" + "label", + "computedAttribute" ], "type": "string" } @@ -1232,6 +1233,9 @@ ], "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", @@ -2015,6 +2019,470 @@ ], "type": "object" }, + "ComputedAttributePermissions": { + "properties": { + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" + }, + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" + }, + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" + } + }, + "required": [ + "rules", + "userGroups", + "users" + ], + "type": "object" + }, + "ComputedAttributePermissionsAssignment": { + "description": "Desired levels of permissions on a computed attribute for an assignee.", + "properties": { + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "permissions" + ], + "type": "object" + }, + "ComputedAttributePermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/ComputedAttributePermissionsAssignment" + }, + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Desired levels of computed-attribute permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "ComputedAttributePermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/ComputedAttributePermissionsAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of computed-attribute permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "ConditionalFormatting": { + "description": "Conditional formatting for a table, with one entry per formatted column.", + "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" + }, + "ConditionalFormattingAbsoluteDateValue": { + "description": "A fixed, inclusive date period.", + "properties": { + "from": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity.", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "absoluteDate" + ], + "type": "string" + }, + "to": { + "description": "`YYYY-MM-DD`, or `YYYY-MM-DD HH:mm` at hour or minute granularity. Inclusive.", + "type": "string" + } + }, + "required": [ + "from", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingAttributeTarget": { + "description": "An attribute column, addressed by its bucket item local identifier.", + "properties": { + "attributeIdentifier": { + "example": "23990482d9d04e62a9c564a29be804f8", + "type": "string" + }, + "kind": { + "description": "The target kind.", + "enum": [ + "attribute" + ], + "type": "string" + } + }, + "required": [ + "attributeIdentifier", + "kind" + ], + "type": "object" + }, + "ConditionalFormattingCondition": { + "description": "A condition and the formatting applied to cells matching it.", + "properties": { + "format": { + "$ref": "#/components/schemas/ConditionalFormattingFormat" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "d0538854-aac3-4fc6-9603-61f49bab6aa3", + "type": "string" + }, + "operator": { + "description": "How a condition compares the cell value against its value.", + "enum": [ + "ALL", + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN", + "LESS_THAN_OR_EQUAL_TO", + "EQUAL_TO", + "NOT_EQUAL_TO", + "BETWEEN", + "NOT_BETWEEN", + "CONTAINS", + "NOT_CONTAINS", + "STARTS_WITH", + "NOT_STARTS_WITH", + "ENDS_WITH", + "NOT_ENDS_WITH", + "IS_EMPTY", + "IS_NOT_EMPTY" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingValue" + } + }, + "required": [ + "format", + "operator", + "value" + ], + "type": "object" + }, + "ConditionalFormattingFormat": { + "description": "Visual formatting applied to a matching cell.", + "properties": { + "backgroundColor": { + "description": "Background color as a hex triplet.", + "example": "#3DB36B", + "type": "string" + }, + "color": { + "description": "Text color as a hex triplet.", + "example": "#E54D40", + "type": "string" + }, + "scope": { + "description": "Whether the formatting applies to the matching cell only, or to its whole row.", + "enum": [ + "cell", + "row" + ], + "type": "string" + } + }, + "required": [ + "scope" + ], + "type": "object" + }, + "ConditionalFormattingLiteral": { + "description": "A string or a number, serialized in whichever form it was authored.", + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "ConditionalFormattingLiteralRangeValue": { + "description": "An inclusive numeric range.", + "properties": { + "from": { + "format": "double", + "type": "number" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "literalRange" + ], + "type": "string" + }, + "to": { + "format": "double", + "type": "number" + } + }, + "required": [ + "from", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingLiteralValue": { + "description": "A single value compared against the cell value.", + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "literal" + ], + "type": "string" + }, + "value": { + "$ref": "#/components/schemas/ConditionalFormattingLiteral" + } + }, + "required": [ + "kind", + "value" + ], + "type": "object" + }, + "ConditionalFormattingMeasureTarget": { + "description": "A measure column, addressed by its bucket item local identifier.", + "properties": { + "kind": { + "description": "The target kind.", + "enum": [ + "measure" + ], + "type": "string" + }, + "measureIdentifier": { + "example": "8cd55fe5748b48d7820ae9ee18e58011", + "type": "string" + } + }, + "required": [ + "kind", + "measureIdentifier" + ], + "type": "object" + }, + "ConditionalFormattingNoneValue": { + "description": "No value; used by operators that take none.", + "properties": { + "kind": { + "description": "The value kind.", + "enum": [ + "none" + ], + "type": "string" + } + }, + "required": [ + "kind" + ], + "type": "object" + }, + "ConditionalFormattingRelativeDateValue": { + "description": "A date period relative to the moment of evaluation, resolved at render time.", + "properties": { + "from": { + "description": "Offset in periods; 0 is the current period, negative is the past.", + "example": -29, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Granularity the offsets are counted in.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "MONTH", + "type": "string" + }, + "kind": { + "description": "The value kind.", + "enum": [ + "relativeDate" + ], + "type": "string" + }, + "to": { + "description": "Offset in periods, not lower than `from`.", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "from", + "granularity", + "kind", + "to" + ], + "type": "object" + }, + "ConditionalFormattingRule": { + "description": "Conditions applied to a single column.", + "properties": { + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" + }, + "id": { + "description": "Client-assigned identifier, stable across edits.", + "example": "bb955b38-a9e6-45f5-b068-155cb7ce509a", + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/ConditionalFormattingTarget" + } + }, + "required": [ + "conditions", + "target" + ], + "type": "object" + }, + "ConditionalFormattingTarget": { + "description": "Column a rule formats. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingAttributeTarget" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingMeasureTarget" + } + ], + "type": "object" + }, + "ConditionalFormattingValue": { + "description": "Value a condition compares against. The shape is selected by the `kind` property.", + "oneOf": [ + { + "$ref": "#/components/schemas/ConditionalFormattingNoneValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingLiteralRangeValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingAbsoluteDateValue" + }, + { + "$ref": "#/components/schemas/ConditionalFormattingRelativeDateValue" + } + ], + "type": "object" + }, "ContentSlideTemplate": { "description": "Settings for content slide.", "nullable": true, @@ -2994,7 +3462,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -3016,6 +3487,14 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "$ref": "#/components/schemas/Instruction" + }, + "nullable": true, + "type": "array" + }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", @@ -3390,6 +3869,13 @@ }, "type": "array" }, + "computedAttributes": { + "description": "A list of computed attributes available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeComputedAttribute" + }, + "type": "array" + }, "dashboardPlugins": { "description": "A list of dashboard plugins available in the model.", "items": { @@ -3432,6 +3918,27 @@ }, "type": "array" }, + "reportPageLayouts": { + "description": "A list of report page layouts available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeReportPageLayout" + }, + "type": "array" + }, + "reportTemplates": { + "description": "A list of report templates available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeReportTemplate" + }, + "type": "array" + }, + "reports": { + "description": "A list of reports available in the model.", + "items": { + "$ref": "#/components/schemas/DeclarativeReport" + }, + "type": "array" + }, "visualizationObjects": { "description": "A list of visualization objects available in the model.", "items": { @@ -3445,6 +3952,9 @@ "DeclarativeAttribute": { "description": "A dataset attribute.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "defaultView": { "$ref": "#/components/schemas/LabelIdentifier" }, @@ -3886,6 +4396,171 @@ ], "type": "object" }, + "DeclarativeComputedAttribute": { + "properties": { + "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.", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "certifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, + "content": { + "$ref": "#/components/schemas/DeclarativeComputedAttributeContent" + }, + "createdAt": { + "description": "Time of the entity creation.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "createdBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, + "dataType": { + "description": "Computed attribute data type", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "example": "STRING", + "maxLength": 255, + "type": "string" + }, + "description": { + "description": "Computed attribute description.", + "example": "Sales for all the data available.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Computed attribute ID.", + "example": "total-sales", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "isHidden": { + "description": "If true, this computed attribute is hidden from AI search results.", + "example": false, + "type": "boolean" + }, + "isNullable": { + "description": "Flag indicating whether the associated source column allows null values.", + "example": false, + "type": "boolean" + }, + "locale": { + "description": "Default locale for primary computed label.", + "example": "en-US", + "type": "string" + }, + "modifiedAt": { + "description": "Time of the last entity modification.", + "example": "2023-07-20 12:30", + "nullable": true, + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "modifiedBy": { + "$ref": "#/components/schemas/DeclarativeUserIdentifier" + }, + "nullValue": { + "description": "Value used in coalesce during joins instead of null.", + "example": "empty_value", + "type": "string" + }, + "tags": { + "description": "A list of tags.", + "example": [ + "Revenues" + ], + "items": { + "description": "A list of tags.", + "example": "[\"Revenues\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Computed attribute title.", + "example": "Total sales", + "maxLength": 255, + "type": "string" + }, + "valueType": { + "description": "Specific type of the computed attribute value", + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" + } + }, + "required": [ + "content", + "id", + "title" + ], + "type": "object" + }, + "DeclarativeComputedAttributeContent": { + "description": "A definition of the computed attribute content.", + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "example": "%0.2f", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "example": "SELECT 1", + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, "DeclarativeCspDirective": { "properties": { "directive": { @@ -4099,6 +4774,11 @@ }, "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" + }, "id": { "description": "Data source ID.", "example": "pg_local_docker-demo", @@ -4182,7 +4862,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "example": "POSTGRESQL", "type": "string" @@ -4417,6 +5098,9 @@ "DeclarativeDateDataset": { "description": "A date dataset.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "description": { "description": "Date dataset description.", "example": "A customer order date", @@ -5000,6 +5684,9 @@ "DeclarativeLabel": { "description": "A attribute label.", "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "description": { "description": "Label description.", "example": "Customer name", @@ -5273,6 +5960,9 @@ "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "conditionalFormatting": { + "$ref": "#/components/schemas/ObjectConditionalFormatting" + }, "content": { "$ref": "#/components/schemas/JsonNode" }, @@ -5829,6 +6519,142 @@ ], "type": "object" }, + "DeclarativeReport": { + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "description": "Report description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Report ID.", + "example": "quarterly-review-2026-h1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "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": { + "description": "A list of tags.", + "example": "[\"brand\"]", + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "title": { + "description": "Report title.", + "maxLength": 255, + "type": "string" + }, + "variableValues": { + "additionalProperties": { + "description": "Values for the variables declared in the content, keyed by name.", + "type": "string" + }, + "description": "Values for the variables declared in the content, keyed by name.", + "type": "object" + } + }, + "required": [ + "content", + "id", + "periodEnd", + "periodStart", + "title" + ], + "type": "object" + }, + "DeclarativeReportPageLayout": { + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "description": "Report page layout description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Report page layout 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": "Report page layout title.", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "title" + ], + "type": "object" + }, + "DeclarativeReportTemplate": { + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "description": { + "description": "Report template description.", + "maxLength": 10000, + "type": "string" + }, + "id": { + "description": "Report template ID.", + "example": "quarterly-review-template", + "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": "Report template title.", + "maxLength": 255, + "type": "string" + } + }, + "required": [ + "content", + "id", + "title" + ], + "type": "object" + }, "DeclarativeRsaSpecification": { "description": "Declarative specification of the cryptographic key.", "properties": { @@ -5950,10 +6776,12 @@ "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", @@ -5961,7 +6789,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "example": "TIMEZONE", "type": "string" @@ -5991,6 +6824,7 @@ "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", "CREATE_VISUALIZATION", "CREATE_COMPUTED_ATTRIBUTE", "VIEW" @@ -6456,6 +7290,9 @@ "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, + "conditionalFormatting": { + "$ref": "#/components/schemas/ConditionalFormatting" + }, "content": { "$ref": "#/components/schemas/JsonNode" }, @@ -6893,6 +7730,7 @@ "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "CREATE_METRIC", + "MANAGE_VISUALIZATIONS", "CREATE_VISUALIZATION", "CREATE_COMPUTED_ATTRIBUTE", "VIEW" @@ -7056,6 +7894,7 @@ "fact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "automation", @@ -7178,6 +8017,7 @@ "fact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "automation", @@ -7797,12 +8637,16 @@ "properties": { "level": { "description": "Level of permission", - "example": "VIEW, SHARE, EDIT", + "example": "VIEW", "type": "string" }, "source": { "description": "Source of permission", - "example": "direct/indirect", + "enum": [ + "direct", + "indirect" + ], + "example": "indirect", "type": "string" } }, @@ -7920,6 +8764,7 @@ "aggregatedFact", "label", "metric", + "computedAttribute", "userDataFilter", "parameter", "exportDefinition", @@ -7935,6 +8780,9 @@ "workspaceDataFilter", "workspaceDataFilterSetting", "filterView", + "reportPageLayout", + "reportTemplate", + "report", "workspaceExportTemplate", "workspaceTheme", "workspaceColorPalette", @@ -8092,6 +8940,41 @@ ], "type": "object" }, + "Instruction": { + "description": "Rule that an agent follows when answering.", + "nullable": true, + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" + ], + "type": "object" + }, "IntroSlideTemplate": { "description": "Settings for intro slide.", "nullable": true, @@ -8120,6 +9003,32 @@ }, "type": "object" }, + "Invitation": { + "properties": { + "email": { + "format": "email", + "type": "string" + }, + "firstName": { + "type": "string" + }, + "forceSend": { + "description": "Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends)", + "type": "boolean" + }, + "lastName": { + "type": "string" + }, + "userId": { + "type": "string" + } + }, + "required": [ + "email", + "userId" + ], + "type": "object" + }, "IpAllowlistPolicyTargets": { "description": "Target delta for IP allowlist policy actions.", "properties": { @@ -8160,7 +9069,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -8175,6 +9087,45 @@ "enabled": { "type": "boolean" }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "description": "Rule that an agent follows when answering.", + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, "isPreview": { "type": "boolean" }, @@ -8275,7 +9226,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -8290,6 +9244,45 @@ "enabled": { "type": "boolean" }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "description": "Rule that an agent follows when answering.", + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, "isPreview": { "type": "boolean" }, @@ -8391,6 +9384,19 @@ }, "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": [ @@ -8433,6 +9439,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" @@ -8478,7 +9492,10 @@ "visualization_summary", "dashboard_summary", "what_if_analysis", - "knowledge" + "knowledge", + "dashboard_builder", + "dashboard_editor", + "report_builder" ], "type": "string" }, @@ -8493,6 +9510,45 @@ "enabled": { "type": "boolean" }, + "instructions": { + "description": "Rules this agent follows when answering.", + "items": { + "description": "Rule that an agent follows when answering.", + "properties": { + "content": { + "description": "The rule the agent follows when answering", + "maxLength": 255, + "type": "string" + }, + "isDisabled": { + "description": "Whether the instruction is disabled", + "nullable": true, + "type": "boolean" + }, + "strategy": { + "description": "When an instruction is applied to a request", + "enum": [ + "ALWAYS", + "AUTO" + ], + "type": "string" + }, + "title": { + "description": "Short name shown in the agent builder.", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "content", + "strategy" + ], + "type": "object" + }, + "nullable": true, + "type": "array" + }, "isPreview": { "type": "boolean" }, @@ -8740,6 +9796,19 @@ }, "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": [ @@ -8785,6 +9854,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" @@ -9068,6 +10145,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -9201,6 +10289,19 @@ }, "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": [ @@ -9213,6 +10314,9 @@ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" }, @@ -9264,6 +10368,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" @@ -9826,6 +10938,19 @@ }, "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": [ @@ -9868,6 +10993,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" @@ -9999,6 +11132,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this attribute.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -10129,6 +11284,18 @@ "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" @@ -10212,6 +11379,19 @@ }, "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": [ @@ -10257,6 +11437,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" @@ -10282,6 +11470,28 @@ "properties": { "attributes": { "properties": { + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this attribute.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -10387,6 +11597,9 @@ ], "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", @@ -10720,6 +11933,9 @@ ], "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", @@ -10990,6 +12206,28 @@ ], "type": "object" }, + "analyticalDashboards": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "attributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "automationResults": { "properties": { "data": { @@ -11001,6 +12239,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -11023,6 +12272,39 @@ ], "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": { @@ -11055,6 +12337,17 @@ "data" ], "type": "object" + }, + "visualizationObjects": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "type": "object" @@ -11089,6 +12382,19 @@ }, "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": [ @@ -11101,12 +12407,27 @@ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" }, @@ -11115,6 +12436,9 @@ }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" } ] }, @@ -11143,6 +12467,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" @@ -11187,6 +12519,9 @@ ], "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", @@ -11592,6 +12927,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" @@ -11826,21 +13169,97 @@ ], "type": "object" }, - "JsonApiCookieSecurityConfigurationIn": { - "description": "JSON:API representation of cookieSecurityConfiguration entity.", + "JsonApiComputedAttributeIn": { + "description": "JSON:API representation of computedAttribute entity.", "properties": { "attributes": { "properties": { - "lastRotation": { - "format": "date-time", + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], "type": "string" }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "type": "string" + }, + "nullValue": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], "type": "string" } }, + "required": [ + "content" + ], "type": "object" }, "id": { @@ -11852,22 +13271,23 @@ "type": { "description": "Object type", "enum": [ - "cookieSecurityConfiguration" + "computedAttribute" ], - "example": "cookieSecurityConfiguration", + "example": "computedAttribute", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiCookieSecurityConfigurationInDocument": { + "JsonApiComputedAttributeInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" + "$ref": "#/components/schemas/JsonApiComputedAttributeIn" } }, "required": [ @@ -11875,35 +13295,16 @@ ], "type": "object" }, - "JsonApiCookieSecurityConfigurationOut": { - "description": "JSON:API representation of cookieSecurityConfiguration entity.", + "JsonApiComputedAttributeLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { - "attributes": { - "properties": { - "lastRotation": { - "format": "date-time", - "type": "string" - }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", - "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": [ - "cookieSecurityConfiguration" + "computedAttribute" ], - "example": "cookieSecurityConfiguration", "type": "string" } }, @@ -11913,35 +13314,133 @@ ], "type": "object" }, - "JsonApiCookieSecurityConfigurationOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationPatch": { - "description": "JSON:API representation of patching cookieSecurityConfiguration entity.", + "JsonApiComputedAttributeOut": { + "description": "JSON:API representation of computedAttribute entity.", "properties": { "attributes": { "properties": { - "lastRotation": { + "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" }, - "rotationInterval": { - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D", + "content": { + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "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" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "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" + }, + "nullValue": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], "type": "string" } }, + "required": [ + "content" + ], "type": "object" }, "id": { @@ -11950,61 +13449,165 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "type": { - "description": "Object type", - "enum": [ - "cookieSecurityConfiguration" - ], - "example": "cookieSecurityConfiguration", - "type": "string" - } - }, - "required": [ - "id", - "type" - ], - "type": "object" - }, - "JsonApiCookieSecurityConfigurationPatchDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCspDirectiveIn": { - "description": "JSON:API representation of cspDirective entity.", - "properties": { - "attributes": { + "meta": { "properties": { - "sources": { + "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" } }, - "required": [ - "sources" - ], "type": "object" }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "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": [ - "cspDirective" + "computedAttribute" ], - "example": "cspDirective", + "example": "computedAttribute", "type": "string" } }, @@ -12015,10 +13618,34 @@ ], "type": "object" }, - "JsonApiCspDirectiveInDocument": { + "JsonApiComputedAttributeOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveIn" + "$ref": "#/components/schemas/JsonApiComputedAttributeOut" + }, + "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": [ @@ -12026,65 +13653,48 @@ ], "type": "object" }, - "JsonApiCspDirectiveOut": { - "description": "JSON:API representation of cspDirective entity.", - "properties": { - "attributes": { - "properties": { - "sources": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "sources" - ], - "type": "object" - }, - "id": { - "description": "API identifier of an object", - "example": "id1", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "JsonApiComputedAttributeOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, - "type": { - "description": "Object type", - "enum": [ - "cspDirective" - ], - "example": "cspDirective", - "type": "string" - } - }, - "required": [ - "attributes", - "id", - "type" - ], - "type": "object" - }, - "JsonApiCspDirectiveOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + { + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "JsonApiCspDirectiveOutList": { + "JsonApiComputedAttributeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" }, "type": "array", "uniqueItems": true @@ -12096,6 +13706,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" @@ -12106,26 +13724,102 @@ ], "type": "object" }, - "JsonApiCspDirectiveOutWithLinks": { + "JsonApiComputedAttributeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + "$ref": "#/components/schemas/JsonApiComputedAttributeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiCspDirectivePatch": { - "description": "JSON:API representation of patching cspDirective entity.", + "JsonApiComputedAttributePatch": { + "description": "JSON:API representation of patching computedAttribute entity.", "properties": { "attributes": { "properties": { - "sources": { + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], + "type": "object" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "type": "string" + }, + "nullValue": { + "type": "string" + }, + "tags": { "items": { "type": "string" }, "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" } }, "type": "object" @@ -12139,9 +13833,9 @@ "type": { "description": "Object type", "enum": [ - "cspDirective" + "computedAttribute" ], - "example": "cspDirective", + "example": "computedAttribute", "type": "string" } }, @@ -12152,10 +13846,10 @@ ], "type": "object" }, - "JsonApiCspDirectivePatchDocument": { + "JsonApiComputedAttributePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatch" + "$ref": "#/components/schemas/JsonApiComputedAttributePatch" } }, "required": [ @@ -12163,23 +13857,95 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingIn": { - "description": "JSON:API representation of customApplicationSetting entity.", + "JsonApiComputedAttributePostOptionalId": { + "description": "JSON:API representation of computedAttribute entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" + "areRelationsValid": { + "type": "boolean" }, "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, + "properties": { + "format": { + "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", + "maxLength": 2048, + "nullable": true, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + }, + "metricType": { + "description": "Categorizes metric semantics (e.g., currency).", + "enum": [ + "UNSPECIFIED", + "CURRENCY" + ], + "type": "string" + } + }, + "required": [ + "maql" + ], "type": "object" + }, + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "isNullable": { + "type": "boolean" + }, + "locale": { + "type": "string" + }, + "nullValue": { + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" + }, + "valueType": { + "enum": [ + "TEXT", + "HYPERLINK", + "GEO", + "GEO_LONGITUDE", + "GEO_LATITUDE", + "GEO_AREA", + "GEO_ICON", + "IMAGE", + "HYPERLOGLOG" + ], + "type": "string" } }, "required": [ - "applicationName", "content" ], "type": "object" @@ -12193,23 +13959,22 @@ "type": { "description": "Object type", "enum": [ - "customApplicationSetting" + "computedAttribute" ], - "example": "customApplicationSetting", + "example": "computedAttribute", "type": "string" } }, "required": [ "attributes", - "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingInDocument": { + "JsonApiComputedAttributePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalId" } }, "required": [ @@ -12217,25 +13982,28 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingOut": { - "description": "JSON:API representation of customApplicationSetting entity.", + "JsonApiComputedAttributeToManyLinkage": { + "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/JsonApiComputedAttributeLinkage" + }, + "type": "array" + }, + "JsonApiCookieSecurityConfigurationIn": { + "description": "JSON:API representation of cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, + "lastRotation": { + "format": "date-time", "type": "string" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, - "type": "object" + "rotationInterval": { + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D", + "type": "string" } }, - "required": [ - "applicationName", - "content" - ], "type": "object" }, "id": { @@ -12244,82 +14012,25 @@ "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": [ - "customApplicationSetting" + "cookieSecurityConfiguration" ], - "example": "customApplicationSetting", + "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "JsonApiCustomApplicationSettingOutList": { - "description": "A JSON:API document with a list of resources", + "JsonApiCookieSecurityConfigurationInDocument": { "properties": { "data": { - "items": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - }, - "type": "object" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" } }, "required": [ @@ -12327,29 +14038,19 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiCustomApplicationSettingPatch": { - "description": "JSON:API representation of patching customApplicationSetting entity.", + "JsonApiCookieSecurityConfigurationOut": { + "description": "JSON:API representation of cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, + "lastRotation": { + "format": "date-time", "type": "string" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, - "type": "object" + "rotationInterval": { + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D", + "type": "string" } }, "type": "object" @@ -12363,23 +14064,25 @@ "type": { "description": "Object type", "enum": [ - "customApplicationSetting" + "cookieSecurityConfiguration" ], - "example": "customApplicationSetting", + "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingPatchDocument": { + "JsonApiCookieSecurityConfigurationOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ @@ -12387,25 +14090,21 @@ ], "type": "object" }, - "JsonApiCustomApplicationSettingPostOptionalId": { - "description": "JSON:API representation of customApplicationSetting entity.", + "JsonApiCookieSecurityConfigurationPatch": { + "description": "JSON:API representation of patching cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { - "applicationName": { - "maxLength": 255, + "lastRotation": { + "format": "date-time", "type": "string" }, - "content": { - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": {}, - "type": "object" + "rotationInterval": { + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D", + "type": "string" } }, - "required": [ - "applicationName", - "content" - ], "type": "object" }, "id": { @@ -12417,22 +14116,22 @@ "type": { "description": "Object type", "enum": [ - "customApplicationSetting" + "cookieSecurityConfiguration" ], - "example": "customApplicationSetting", + "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ - "attributes", + "id", "type" ], "type": "object" }, - "JsonApiCustomApplicationSettingPostOptionalIdDocument": { + "JsonApiCookieSecurityConfigurationPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalId" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" } }, "required": [ @@ -12440,22 +14139,21 @@ ], "type": "object" }, - "JsonApiCustomGeoCollectionIn": { - "description": "JSON:API representation of customGeoCollection entity.", + "JsonApiCspDirectiveIn": { + "description": "JSON:API representation of cspDirective entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" + "sources": { + "items": { + "type": "string" + }, + "type": "array" } }, + "required": [ + "sources" + ], "type": "object" }, "id": { @@ -12467,22 +14165,23 @@ "type": { "description": "Object type", "enum": [ - "customGeoCollection" + "cspDirective" ], - "example": "customGeoCollection", + "example": "cspDirective", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomGeoCollectionInDocument": { + "JsonApiCspDirectiveInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionIn" + "$ref": "#/components/schemas/JsonApiCspDirectiveIn" } }, "required": [ @@ -12490,22 +14189,21 @@ ], "type": "object" }, - "JsonApiCustomGeoCollectionOut": { - "description": "JSON:API representation of customGeoCollection entity.", + "JsonApiCspDirectiveOut": { + "description": "JSON:API representation of cspDirective entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" + "sources": { + "items": { + "type": "string" + }, + "type": "array" } }, + "required": [ + "sources" + ], "type": "object" }, "id": { @@ -12517,22 +14215,23 @@ "type": { "description": "Object type", "enum": [ - "customGeoCollection" + "cspDirective" ], - "example": "customGeoCollection", + "example": "cspDirective", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomGeoCollectionOutDocument": { + "JsonApiCspDirectiveOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" + "$ref": "#/components/schemas/JsonApiCspDirectiveOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -12543,12 +14242,12 @@ ], "type": "object" }, - "JsonApiCustomGeoCollectionOutList": { + "JsonApiCspDirectiveOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutWithLinks" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" }, "type": "array", "uniqueItems": true @@ -12570,30 +14269,26 @@ ], "type": "object" }, - "JsonApiCustomGeoCollectionOutWithLinks": { + "JsonApiCspDirectiveOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" + "$ref": "#/components/schemas/JsonApiCspDirectiveOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiCustomGeoCollectionPatch": { - "description": "JSON:API representation of patching customGeoCollection entity.", + "JsonApiCspDirectivePatch": { + "description": "JSON:API representation of patching cspDirective entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, - "nullable": true, - "type": "string" - }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" + "sources": { + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -12607,22 +14302,23 @@ "type": { "description": "Object type", "enum": [ - "customGeoCollection" + "cspDirective" ], - "example": "customGeoCollection", + "example": "cspDirective", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiCustomGeoCollectionPatchDocument": { + "JsonApiCspDirectivePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatch" + "$ref": "#/components/schemas/JsonApiCspDirectivePatch" } }, "required": [ @@ -12630,8 +14326,8 @@ ], "type": "object" }, - "JsonApiCustomUserApplicationSettingIn": { - "description": "JSON:API representation of customUserApplicationSetting entity.", + "JsonApiCustomApplicationSettingIn": { + "description": "JSON:API representation of customApplicationSetting entity.", "properties": { "attributes": { "properties": { @@ -12643,12 +14339,6 @@ "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" - }, - "workspaceId": { - "description": "Workspace scope for this setting. Must reference an existing workspace the caller has at least VIEW access to. Null means user-level (no workspace scope).", - "maxLength": 255, - "nullable": true, - "type": "string" } }, "required": [ @@ -12666,9 +14356,9 @@ "type": { "description": "Object type", "enum": [ - "customUserApplicationSetting" + "customApplicationSetting" ], - "example": "customUserApplicationSetting", + "example": "customApplicationSetting", "type": "string" } }, @@ -12679,10 +14369,483 @@ ], "type": "object" }, - "JsonApiCustomUserApplicationSettingInDocument": { + "JsonApiCustomApplicationSettingInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingIn" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOut": { + "description": "JSON:API representation of customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "type": "object" + } + }, + "required": [ + "applicationName", + "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" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "customApplicationSetting" + ], + "example": "customApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiCustomApplicationSettingPatch": { + "description": "JSON:API representation of patching customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "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": [ + "customApplicationSetting" + ], + "example": "customApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingPostOptionalId": { + "description": "JSON:API representation of customApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "type": "object" + } + }, + "required": [ + "applicationName", + "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": [ + "customApplicationSetting" + ], + "example": "customApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "type" + ], + "type": "object" + }, + "JsonApiCustomApplicationSettingPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionIn": { + "description": "JSON:API representation of customGeoCollection entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "customGeoCollection" + ], + "example": "customGeoCollection", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionOut": { + "description": "JSON:API representation of customGeoCollection entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "customGeoCollection" + ], + "example": "customGeoCollection", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionOutDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionOutList": { + "description": "A JSON:API document with a list of resources", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiCustomGeoCollectionPatch": { + "description": "JSON:API representation of patching customGeoCollection entity.", + "properties": { + "attributes": { + "properties": { + "description": { + "maxLength": 10000, + "nullable": true, + "type": "string" + }, + "name": { + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", + "enum": [ + "customGeoCollection" + ], + "example": "customGeoCollection", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomGeoCollectionPatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatch" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiCustomUserApplicationSettingIn": { + "description": "JSON:API representation of customUserApplicationSetting entity.", + "properties": { + "attributes": { + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": {}, + "type": "object" + }, + "workspaceId": { + "description": "Workspace scope for this setting. Must reference an existing workspace the caller has at least VIEW access to. Null means user-level (no workspace scope).", + "maxLength": 255, + "nullable": true, + "type": "string" + } + }, + "required": [ + "applicationName", + "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": [ + "customUserApplicationSetting" + ], + "example": "customUserApplicationSetting", + "type": "string" + } + }, + "required": [ + "attributes", + "id", + "type" + ], + "type": "object" + }, + "JsonApiCustomUserApplicationSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingIn" } }, "required": [ @@ -13069,6 +15232,19 @@ }, "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": [ @@ -13101,6 +15277,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" @@ -13296,7 +15480,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" } @@ -13466,6 +15651,11 @@ "nullable": true, "type": "string" }, + "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" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -13549,7 +15739,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" }, @@ -13689,6 +15880,11 @@ "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" @@ -13752,7 +15948,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" }, @@ -13934,6 +16131,11 @@ "nullable": true, "type": "string" }, + "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" + }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, @@ -14017,7 +16219,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "type": "string" }, @@ -14411,6 +16614,19 @@ }, "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": [ @@ -14462,6 +16678,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" @@ -14930,6 +17154,19 @@ }, "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": [ @@ -14978,6 +17215,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" @@ -15794,6 +18039,18 @@ "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" @@ -15844,6 +18101,19 @@ }, "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": [ @@ -15876,6 +18146,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" @@ -16141,6 +18419,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "datasets": { "properties": { "data": { @@ -16152,6 +18441,17 @@ ], "type": "object" }, + "facts": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "labels": { "properties": { "data": { @@ -16162,6 +18462,17 @@ "data" ], "type": "object" + }, + "metrics": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "type": "object" @@ -16197,6 +18508,19 @@ }, "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": [ @@ -16209,11 +18533,20 @@ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiComputedAttributeOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, + { + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" + }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" } ] }, @@ -16242,6 +18575,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" @@ -16607,6 +18948,19 @@ }, "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": [ @@ -16649,6 +19003,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" @@ -17520,6 +19882,19 @@ }, "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": [ @@ -17562,6 +19937,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" @@ -18162,6 +20545,19 @@ }, "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": [ @@ -18204,6 +20600,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" @@ -18590,6 +20994,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -18711,6 +21137,18 @@ "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" @@ -18761,6 +21199,19 @@ }, "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": [ @@ -18793,6 +21244,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" @@ -18818,6 +21277,28 @@ "properties": { "attributes": { "properties": { + "conditionalFormatting": { + "description": "Conditional formatting applied to table columns that render this label, taking precedence over the rules of its attribute. When absent, a primary label falls back to those rules and every other label is left unformatted.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "description": { "maxLength": 10000, "type": "string" @@ -19498,6 +21979,19 @@ }, "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": [ @@ -19530,6 +22024,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" @@ -19725,6 +22227,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -19857,6 +22381,28 @@ "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -19953,6 +22499,18 @@ "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" @@ -19981,6 +22539,17 @@ ], "type": "object" }, + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, "createdBy": { "properties": { "data": { @@ -20085,13 +22654,26 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$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": [ @@ -20099,31 +22681,6 @@ ], "type": "object" }, - "JsonApiMetricOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" - } - ] - }, "JsonApiMetricOutList": { "description": "A JSON:API document with a list of resources", "properties": { @@ -20137,7 +22694,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" }, "type": "array", "uniqueItems": true @@ -20149,6 +22706,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" @@ -20177,6 +22742,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -20267,6 +22854,28 @@ "areRelationsValid": { "type": "boolean" }, + "conditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this metric.", + "nullable": true, + "properties": { + "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": [ + "conditions", + "enabled" + ], + "type": "object" + }, "content": { "properties": { "format": { @@ -21169,6 +23778,19 @@ }, "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": [ @@ -21201,6 +23823,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" @@ -21540,6 +24170,19 @@ }, "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": [ @@ -21700,10 +24343,12 @@ "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", @@ -21711,7 +24356,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" } @@ -21803,10 +24453,12 @@ "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", @@ -21814,7 +24466,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" } @@ -21946,10 +24603,12 @@ "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", @@ -21957,7 +24616,12 @@ "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "HLL_TYPE", + "ENABLE_TIMEZONE_CHANGE", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" ], "type": "string" } @@ -22246,6 +24910,19 @@ }, "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": [ @@ -22278,6 +24955,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" @@ -22459,218 +25144,289 @@ }, "type": "array" }, - "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.", + "JsonApiReportIn": { + "description": "JSON:API representation of report entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" + "areRelationsValid": { + "type": "boolean" }, - "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": {}, + "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" }, - "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, + "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": { @@ -22682,10 +25438,19 @@ "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, "required": [ - "maql" + "content", + "periodEnd", + "periodStart", + "title" ], "type": "object" }, @@ -22695,39 +25460,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" + "report" ], - "example": "userDataFilter", + "example": "report", "type": "string" } }, @@ -22738,10 +25476,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterInDocument": { + "JsonApiReportInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + "$ref": "#/components/schemas/JsonApiReportIn" } }, "required": [ @@ -22749,20 +25487,305 @@ ], "type": "object" }, - "JsonApiUserDataFilterOut": { - "description": "JSON:API representation of userDataFilter entity.", + "JsonApiReportOut": { + "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" + }, + "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" + }, + "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": { @@ -22774,10 +25797,19 @@ "title": { "maxLength": 255, "type": "string" + }, + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, "required": [ - "maql" + "content", + "periodEnd", + "periodStart", + "title" ], "type": "object" }, @@ -22815,76 +25847,10 @@ }, "relationships": { "properties": { - "attributes": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" - } - }, - "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": [ @@ -22892,10 +25858,10 @@ ], "type": "object" }, - "userGroup": { + "modifiedBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -22909,9 +25875,9 @@ "type": { "description": "Object type", "enum": [ - "userDataFilter" + "report" ], - "example": "userDataFilter", + "example": "report", "type": "string" } }, @@ -22922,21 +25888,34 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutDocument": { + "JsonApiReportOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "$ref": "#/components/schemas/JsonApiReportOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$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": [ @@ -22944,40 +25923,12 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$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": { + "JsonApiReportOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportOutWithLinks" }, "type": "array", "uniqueItems": true @@ -22985,7 +25936,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -22997,6 +25948,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" @@ -23007,29 +25966,154 @@ ], "type": "object" }, - "JsonApiUserDataFilterOutWithLinks": { + "JsonApiReportOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" + "$ref": "#/components/schemas/JsonApiReportOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserDataFilterPatch": { - "description": "JSON:API representation of patching 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" }, @@ -23044,6 +26128,10 @@ "type": "string" } }, + "required": [ + "content", + "title" + ], "type": "object" }, "id": { @@ -23052,39 +26140,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" } }, @@ -23095,10 +26156,10 @@ ], "type": "object" }, - "JsonApiUserDataFilterPatchDocument": { + "JsonApiReportPageLayoutInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" + "$ref": "#/components/schemas/JsonApiReportPageLayoutIn" } }, "required": [ @@ -23106,20 +26167,161 @@ ], "type": "object" }, - "JsonApiUserDataFilterPostOptionalId": { - "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": { @@ -23134,7 +26336,8 @@ } }, "required": [ - "maql" + "content", + "title" ], "type": "object" }, @@ -23144,162 +26347,49 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { + "meta": { "properties": { - "user": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - }, - "required": [ - "data" - ], - "type": "object" - }, - "userGroup": { + "origin": { "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + "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" } }, "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": { + "createdBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "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": { + }, + "modifiedBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -23313,33 +26403,47 @@ "type": { "description": "Object type", "enum": [ - "userGroup" + "reportPageLayout" ], - "example": "userGroup", + "example": "reportPageLayout", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserGroupOutDocument": { + "JsonApiReportPageLayoutOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupOut" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$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": [ @@ -23347,12 +26451,12 @@ ], "type": "object" }, - "JsonApiUserGroupOutList": { + "JsonApiReportPageLayoutOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutWithLinks" }, "type": "array", "uniqueItems": true @@ -23360,7 +26464,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -23372,6 +26476,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" @@ -23382,22 +26494,164 @@ ], "type": "object" }, - "JsonApiUserGroupOutWithLinks": { + "JsonApiReportPageLayoutOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserGroupOut" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserGroupPatch": { - "description": "JSON:API representation of patching userGroup entity.", + "JsonApiReportPageLayoutPatch": { + "description": "JSON:API representation of patching reportPageLayout entity.", "properties": { "attributes": { "properties": { - "name": { + "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" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" } @@ -23410,41 +26664,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" + "reportPageLayout" ], - "example": "userGroup", + "example": "reportPageLayout", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserGroupPatchDocument": { + "JsonApiReportPageLayoutPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupPatch" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatch" } }, "required": [ @@ -23452,57 +26691,496 @@ ], "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.", + "JsonApiReportPageLayoutPostOptionalId": { + "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" + }, + "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": [ - "userIdentifier" + "reportPageLayout" ], + "example": "reportPageLayout", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiUserIdentifierOut": { - "description": "JSON:API representation of userIdentifier entity.", + "JsonApiReportPageLayoutPostOptionalIdDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalId" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportPatch": { + "description": "JSON:API representation of patching report entity.", "properties": { "attributes": { "properties": { - "email": { - "maxLength": 255, + "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" }, - "firstname": { - "maxLength": 255, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", "type": "string" }, - "lastname": { + "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" @@ -23516,52 +27194,23 @@ "type": { "description": "Object type", "enum": [ - "userIdentifier" + "report" ], - "example": "userIdentifier", + "example": "report", "type": "string" } }, "required": [ + "attributes", "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", + "JsonApiReportPatchDocument": { "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/JsonApiReportPatch" } }, "required": [ @@ -23569,52 +27218,314 @@ ], "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.", + "JsonApiReportPostOptionalId": { + "description": "JSON:API representation of report entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, + "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" }, - "email": { - "maxLength": 255, + "periodEnd": { + "description": "Last day of the reported period, inclusive.", + "example": "2026-06-30", + "format": "date", "type": "string" }, - "firstname": { - "maxLength": 255, + "periodStart": { + "description": "First day of the reported period, inclusive.", + "example": "2026-01-01", + "format": "date", "type": "string" }, - "lastname": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" + "variableValues": { + "description": "Values for the variables declared in the content, keyed by name.", + "example": { + "regionName": "EMEA" + } } }, + "required": [ + "content", + "periodEnd", + "periodStart", + "title" + ], "type": "object" }, "id": { @@ -23623,41 +27534,25 @@ "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" + "report" ], - "example": "user", + "example": "report", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiUserInDocument": { + "JsonApiReportPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIn" + "$ref": "#/components/schemas/JsonApiReportPostOptionalId" } }, "required": [ @@ -23665,52 +27560,595 @@ ], "type": "object" }, - "JsonApiUserLinkage": { - "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "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": [ - "user" + "reportTemplate" ], + "example": "reportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserOut": { - "description": "JSON:API representation of user entity.", + "JsonApiReportTemplateInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiReportTemplateIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiReportTemplateOut": { + "description": "JSON:API representation of reportTemplate entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, + "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" }, - "email": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "firstname": { - "maxLength": 255, + "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" }, - "lastname": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, + "required": [ + "content", + "title" + ], "type": "object" }, "id": { @@ -23719,12 +28157,49 @@ "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": { + "createdBy": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ @@ -23738,33 +28213,47 @@ "type": { "description": "Object type", "enum": [ - "user" + "reportTemplate" ], - "example": "user", + "example": "reportTemplate", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserOutDocument": { + "JsonApiReportTemplateOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiReportTemplateOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$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": [ @@ -23772,12 +28261,12 @@ ], "type": "object" }, - "JsonApiUserOutList": { + "JsonApiReportTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "$ref": "#/components/schemas/JsonApiReportTemplateOutWithLinks" }, "type": "array", "uniqueItems": true @@ -23785,7 +28274,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -23797,6 +28286,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" @@ -23807,41 +28304,279 @@ ], "type": "object" }, - "JsonApiUserOutWithLinks": { + "JsonApiReportTemplateOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiReportTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserPatch": { - "description": "JSON:API representation of patching user entity.", + "JsonApiReportTemplatePatch": { + "description": "JSON:API representation of patching reportTemplate entity.", "properties": { "attributes": { "properties": { - "authenticationId": { - "maxLength": 255, - "type": "string" + "areRelationsValid": { + "type": "boolean" }, - "email": { - "maxLength": 255, - "type": "string" + "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" }, - "firstname": { - "maxLength": 255, + "description": { + "maxLength": 10000, "type": "string" }, - "lastname": { + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { "maxLength": 255, "type": "string" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" } }, "type": "object" @@ -23852,41 +28587,329 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "relationships": { - "properties": { - "userGroups": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } - }, - "required": [ - "data" - ], + "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": [ - "user" + "reportTemplate" ], - "example": "user", + "example": "reportTemplate", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiUserPatchDocument": { + "JsonApiReportTemplatePostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserPatch" + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalId" } }, "required": [ @@ -23894,8 +28917,8 @@ ], "type": "object" }, - "JsonApiUserSettingIn": { - "description": "JSON:API representation of userSetting entity.", + "JsonApiThemeIn": { + "description": "JSON:API representation of theme entity.", "properties": { "attributes": { "properties": { @@ -23904,65 +28927,15 @@ "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "name": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -23974,22 +28947,23 @@ "type": { "description": "Object type", "enum": [ - "userSetting" + "theme" ], - "example": "userSetting", + "example": "theme", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserSettingInDocument": { + "JsonApiThemeInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserSettingIn" + "$ref": "#/components/schemas/JsonApiThemeIn" } }, "required": [ @@ -23997,8 +28971,8 @@ ], "type": "object" }, - "JsonApiUserSettingOut": { - "description": "JSON:API representation of userSetting entity.", + "JsonApiThemeOut": { + "description": "JSON:API representation of theme entity.", "properties": { "attributes": { "properties": { @@ -24007,65 +28981,15 @@ "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "name": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content", + "name" + ], "type": "object" }, "id": { @@ -24077,22 +29001,23 @@ "type": { "description": "Object type", "enum": [ - "userSetting" + "theme" ], - "example": "userSetting", + "example": "theme", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiUserSettingOutDocument": { + "JsonApiThemeOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserSettingOut" + "$ref": "#/components/schemas/JsonApiThemeOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -24103,12 +29028,12 @@ ], "type": "object" }, - "JsonApiUserSettingOutList": { + "JsonApiThemeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" + "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" }, "type": "array", "uniqueItems": true @@ -24130,57 +29055,81 @@ ], "type": "object" }, - "JsonApiUserSettingOutWithLinks": { + "JsonApiThemeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserSettingOut" + "$ref": "#/components/schemas/JsonApiThemeOut" }, { "$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" + "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" + } }, - "type": "array" + "required": [ + "attributes", + "id", + "type" + ], + "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, - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiUserLinkage" + "JsonApiThemePatchDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiThemePatch" } - ] + }, + "required": [ + "data" + ], + "type": "object" }, - "JsonApiVisualizationObjectIn": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiUserDataFilterIn": { + "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "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" + "maql": { + "maxLength": 10000, + "type": "string" }, "tags": { "items": { @@ -24194,7 +29143,7 @@ } }, "required": [ - "content" + "maql" ], "type": "object" }, @@ -24204,12 +29153,39 @@ "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": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -24220,10 +29196,10 @@ ], "type": "object" }, - "JsonApiVisualizationObjectInDocument": { + "JsonApiUserDataFilterInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + "$ref": "#/components/schemas/JsonApiUserDataFilterIn" } }, "required": [ @@ -24231,85 +29207,20 @@ ], "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.", + "JsonApiUserDataFilterOut": { + "description": "JSON:API representation of userDataFilter 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" - }, - "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}", + "maql": { + "maxLength": 10000, "type": "string" }, "tags": { @@ -24324,7 +29235,7 @@ } }, "required": [ - "content" + "maql" ], "type": "object" }, @@ -24373,10 +29284,10 @@ ], "type": "object" }, - "certifiedBy": { + "computedAttributes": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" } }, "required": [ @@ -24384,10 +29295,10 @@ ], "type": "object" }, - "createdBy": { + "datasets": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ @@ -24395,10 +29306,10 @@ ], "type": "object" }, - "datasets": { + "facts": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, "required": [ @@ -24406,10 +29317,10 @@ ], "type": "object" }, - "facts": { + "labels": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiFactToManyLinkage" + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ @@ -24417,10 +29328,10 @@ ], "type": "object" }, - "labels": { + "metrics": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ @@ -24428,10 +29339,10 @@ ], "type": "object" }, - "metrics": { + "parameters": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ @@ -24439,10 +29350,10 @@ ], "type": "object" }, - "modifiedBy": { + "user": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ @@ -24450,10 +29361,10 @@ ], "type": "object" }, - "parameters": { + "userGroup": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ @@ -24467,9 +29378,9 @@ "type": { "description": "Object type", "enum": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -24480,21 +29391,34 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutDocument": { + "JsonApiUserDataFilterOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$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": [ @@ -24502,12 +29426,43 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutList": { + "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/JsonApiVisualizationObjectOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true @@ -24515,7 +29470,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" }, "type": "array", "uniqueItems": true @@ -24527,6 +29482,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" @@ -24537,41 +29500,31 @@ ], "type": "object" }, - "JsonApiVisualizationObjectOutWithLinks": { + "JsonApiUserDataFilterOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiVisualizationObjectPatch": { - "description": "JSON:API representation of patching visualizationObject entity.", + "JsonApiUserDataFilterPatch": { + "description": "JSON:API representation of patching userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "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" + "maql": { + "maxLength": 10000, + "type": "string" }, "tags": { "items": { @@ -24592,12 +29545,39 @@ "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": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -24608,10 +29588,10 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPatchDocument": { + "JsonApiUserDataFilterPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" + "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" } }, "required": [ @@ -24619,31 +29599,21 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalId": { - "description": "JSON:API representation of visualizationObject entity.", + "JsonApiUserDataFilterPostOptionalId": { + "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, - "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" + "maql": { + "maxLength": 10000, + "type": "string" }, "tags": { "items": { @@ -24657,7 +29627,7 @@ } }, "required": [ - "content" + "maql" ], "type": "object" }, @@ -24667,12 +29637,39 @@ "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": [ - "visualizationObject" + "userDataFilter" ], - "example": "visualizationObject", + "example": "userDataFilter", "type": "string" } }, @@ -24682,10 +29679,10 @@ ], "type": "object" }, - "JsonApiVisualizationObjectPostOptionalIdDocument": { + "JsonApiUserDataFilterPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" + "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" } }, "required": [ @@ -24693,259 +29690,14 @@ ], "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.", + "JsonApiUserGroupIn": { + "description": "JSON:API representation of userGroup 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" - }, - "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": { + "name": { "maxLength": 255, "type": "string" - }, - "visualExports": { - "items": { - "properties": { - "requestPayload": { - "$ref": "#/components/schemas/VisualExportRequest" - } - }, - "required": [ - "requestPayload" - ], - "type": "object" - }, - "type": "array" } }, "type": "object" @@ -24958,87 +29710,10 @@ }, "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": { + "parents": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -25052,9 +29727,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceAutomation" + "userGroup" ], - "example": "workspaceAutomation", + "example": "userGroup", "type": "string" } }, @@ -25064,59 +29739,10 @@ ], "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", + "JsonApiUserGroupInDocument": { "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" - } - }, - "type": "object" + "$ref": "#/components/schemas/JsonApiUserGroupIn" } }, "required": [ @@ -25124,89 +29750,35 @@ ], "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" + "JsonApiUserGroupLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", + "properties": { + "id": { + "type": "string" }, "type": { - "description": "Object type", "enum": [ - "workspaceColorPalette" + "userGroup" ], - "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.", + "JsonApiUserGroupOut": { + "description": "JSON:API representation of userGroup 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": { @@ -25215,26 +29787,16 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "meta": { + "relationships": { "properties": { - "origin": { + "parents": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ - "originId", - "originType" + "data" ], "type": "object" } @@ -25244,26 +29806,46 @@ "type": { "description": "Object type", "enum": [ - "workspaceColorPalette" + "userGroup" ], - "example": "workspaceColorPalette", + "example": "userGroup", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutDocument": { + "JsonApiUserGroupOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "$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": [ @@ -25271,12 +29853,20 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutList": { + "JsonApiUserGroupOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true @@ -25288,6 +29878,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" @@ -25298,26 +29896,21 @@ ], "type": "object" }, - "JsonApiWorkspaceColorPaletteOutWithLinks": { + "JsonApiUserGroupOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" + "$ref": "#/components/schemas/JsonApiUserGroupOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceColorPalettePatch": { - "description": "JSON:API representation of patching workspaceColorPalette entity.", + "JsonApiUserGroupPatch": { + "description": "JSON:API representation of patching userGroup entity.", "properties": { "attributes": { "properties": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, - "type": "object" - }, "name": { "maxLength": 255, "type": "string" @@ -25331,65 +29924,12 @@ "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": { + "parents": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -25403,9 +29943,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilter" + "userGroup" ], - "example": "workspaceDataFilter", + "example": "userGroup", "type": "string" } }, @@ -25415,10 +29955,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterInDocument": { + "JsonApiUserGroupPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" + "$ref": "#/components/schemas/JsonApiUserGroupPatch" } }, "required": [ @@ -25426,7 +29966,23 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterLinkage": { + "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": { @@ -25434,7 +29990,7 @@ }, "type": { "enum": [ - "workspaceDataFilter" + "userIdentifier" ], "type": "string" } @@ -25445,20 +30001,20 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOut": { - "description": "JSON:API representation of workspaceDataFilter entity.", + "JsonApiUserIdentifierOut": { + "description": "JSON:API representation of userIdentifier entity.", "properties": { "attributes": { "properties": { - "columnName": { + "email": { "maxLength": 255, "type": "string" }, - "description": { - "maxLength": 10000, + "firstname": { + "maxLength": 255, "type": "string" }, - "title": { + "lastname": { "maxLength": 255, "type": "string" } @@ -25471,54 +30027,12 @@ "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" + "userIdentifier" ], - "example": "workspaceDataFilter", + "example": "userIdentifier", "type": "string" } }, @@ -25528,18 +30042,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutDocument": { + "JsonApiUserIdentifierOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" - }, - "included": { - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - }, - "type": "array", - "uniqueItems": true + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -25550,20 +30056,12 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutList": { + "JsonApiUserIdentifierOutList": { "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" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true @@ -25585,102 +30083,50 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterOutWithLinks": { + "JsonApiUserIdentifierOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceDataFilterPatch": { - "description": "JSON:API representation of patching workspaceDataFilter entity.", + "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": { - "columnName": { + "authenticationId": { "maxLength": 255, "type": "string" }, - "description": { - "maxLength": 10000, + "email": { + "maxLength": 255, "type": "string" }, - "title": { + "firstname": { "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": { + "lastname": { "maxLength": 255, "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" } }, "type": "object" @@ -25693,10 +30139,10 @@ }, "relationships": { "properties": { - "workspaceDataFilter": { + "userGroups": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -25710,9 +30156,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilterSetting" + "user" ], - "example": "workspaceDataFilterSetting", + "example": "user", "type": "string" } }, @@ -25722,10 +30168,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingInDocument": { + "JsonApiUserInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" + "$ref": "#/components/schemas/JsonApiUserIn" } }, "required": [ @@ -25733,7 +30179,7 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingLinkage": { + "JsonApiUserLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { @@ -25741,7 +30187,7 @@ }, "type": { "enum": [ - "workspaceDataFilterSetting" + "user" ], "type": "string" } @@ -25752,24 +30198,31 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOut": { - "description": "JSON:API representation of workspaceDataFilterSetting entity.", + "JsonApiUserOut": { + "description": "JSON:API representation of user entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, + "authenticationId": { + "maxLength": 255, "type": "string" }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" + "email": { + "maxLength": 255, + "type": "string" }, - "title": { + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { "maxLength": 255, "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" } }, "type": "object" @@ -25780,38 +30233,12 @@ "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": { + "userGroups": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -25825,9 +30252,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilterSetting" + "user" ], - "example": "workspaceDataFilterSetting", + "example": "user", "type": "string" } }, @@ -25837,21 +30264,34 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutDocument": { + "JsonApiUserOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "$ref": "#/components/schemas/JsonApiUserOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "$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": [ @@ -25859,12 +30299,12 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutList": { + "JsonApiUserOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, "type": "array", "uniqueItems": true @@ -25872,7 +30312,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true @@ -25884,6 +30324,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" @@ -25894,34 +30342,41 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingOutWithLinks": { + "JsonApiUserOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + "$ref": "#/components/schemas/JsonApiUserOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceDataFilterSettingPatch": { - "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", + "JsonApiUserPatch": { + "description": "JSON:API representation of patching user entity.", "properties": { "attributes": { "properties": { - "description": { - "maxLength": 10000, + "authenticationId": { + "maxLength": 255, "type": "string" }, - "filterValues": { - "items": { - "type": "string" - }, - "type": "array" + "email": { + "maxLength": 255, + "type": "string" }, - "title": { + "firstname": { + "maxLength": 255, + "type": "string" + }, + "lastname": { "maxLength": 255, "type": "string" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" } }, "type": "object" @@ -25934,10 +30389,10 @@ }, "relationships": { "properties": { - "workspaceDataFilter": { + "userGroups": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ @@ -25951,9 +30406,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceDataFilterSetting" + "user" ], - "example": "workspaceDataFilterSetting", + "example": "user", "type": "string" } }, @@ -25963,10 +30418,10 @@ ], "type": "object" }, - "JsonApiWorkspaceDataFilterSettingPatchDocument": { + "JsonApiUserPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" + "$ref": "#/components/schemas/JsonApiUserPatch" } }, "required": [ @@ -25974,110 +30429,81 @@ ], "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.", + "JsonApiUserSettingIn": { + "description": "JSON:API representation of userSetting 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" - ], + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, "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": { + "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": "object" + "type": "string" } }, - "required": [ - "name" - ], "type": "object" }, "id": { @@ -26089,23 +30515,22 @@ "type": { "description": "Object type", "enum": [ - "workspaceExportTemplate" + "userSetting" ], - "example": "workspaceExportTemplate", + "example": "userSetting", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateInDocument": { + "JsonApiUserSettingInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" + "$ref": "#/components/schemas/JsonApiUserSettingIn" } }, "required": [ @@ -26113,87 +30538,81 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOut": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "JsonApiUserSettingOut": { + "description": "JSON:API representation of userSetting 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" - ], + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, "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": { + "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": "object" + "type": "string" } }, - "required": [ - "name" - ], "type": "object" }, "id": { @@ -26202,52 +30621,25 @@ "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" + "userSetting" ], - "example": "workspaceExportTemplate", + "example": "userSetting", "type": "string" } }, "required": [ - "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutDocument": { + "JsonApiUserSettingOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + "$ref": "#/components/schemas/JsonApiUserSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -26258,12 +30650,12 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutList": { + "JsonApiUserSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" }, "type": "array", "uniqueItems": true @@ -26285,94 +30677,94 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplateOutWithLinks": { + "JsonApiUserSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" + "$ref": "#/components/schemas/JsonApiUserSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceExportTemplatePatch": { - "description": "JSON:API representation of patching workspaceExportTemplate entity.", + "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": { - "dashboardSlidesTemplate": { - "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "areRelationsValid": { + "type": "boolean" + }, + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", "nullable": true, "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], + "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": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" + "$ref": "#/components/schemas/ConditionalFormattingRule" }, - "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" + "enabled", + "rules" ], "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" + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } + "someBoolProp": false }, - "required": [ - "appliedOn" - ], "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": { @@ -26384,9 +30776,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceExportTemplate" + "visualizationObject" ], - "example": "workspaceExportTemplate", + "example": "visualizationObject", "type": "string" } }, @@ -26397,10 +30789,10 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePatchDocument": { + "JsonApiVisualizationObjectInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" + "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" } }, "required": [ @@ -26408,86 +30800,122 @@ ], "type": "object" }, - "JsonApiWorkspaceExportTemplatePostOptionalId": { - "description": "JSON:API representation of workspaceExportTemplate entity.", + "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": { - "dashboardSlidesTemplate": { - "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "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": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], + "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": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" + "$ref": "#/components/schemas/ConditionalFormattingRule" }, - "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" + "enabled", + "rules" ], "type": "object" }, - "name": { - "description": "User-facing name of the Slides template.", - "maxLength": 255, + "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" }, - "widgetSlidesTemplate": { - "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "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, - "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" - } + "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", + "type": "string" + }, + "tags": { + "items": { + "type": "string" }, - "required": [ - "appliedOn" - ], - "type": "object" + "type": "array" + }, + "title": { + "maxLength": 255, + "type": "string" } }, "required": [ - "name" + "content" ], "type": "object" }, @@ -26497,325 +30925,149 @@ "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": { + "meta": { "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.", + "origin": { "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", + "originId": { + "description": "defines id of the workspace where the entity comes from", "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" + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" } }, "required": [ - "id" + "originId", + "originType" ], "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.", + "permissions": { + "description": "List of valid permissions for a logged-in user.", "items": { - "maxLength": 255, + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], "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": { + "attributes": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "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.", + "certifiedBy": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ - "id" + "data" ], "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" + "computedAttributes": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiComputedAttributeToManyLinkage" + } }, - "nullable": true, - "type": "array" + "required": [ + "data" + ], + "type": "object" }, - "managed": { - "description": "Whether the object is platform-managed and read-only.", - "type": "boolean" + "createdBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" }, - "name": { - "maxLength": 255, - "nullable": true, - "type": "string" + "datasets": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" }, - "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": { + "facts": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, + "required": [ + "data" + ], "type": "object" }, - "dataModel": { + "labels": { "properties": { - "datasetCount": { - "description": "include the number of dataset of each workspace", - "format": "int32", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ - "datasetCount" + "data" ], "type": "object" }, - "hierarchy": { + "metrics": { "properties": { - "childrenCount": { - "description": "include the number of direct children of each workspace", - "format": "int32", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ - "childrenCount" + "data" ], "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" + "modifiedBy": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" + } }, - "type": "array" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { + "required": [ + "data" + ], + "type": "object" + }, + "parameters": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ @@ -26829,33 +31081,47 @@ "type": { "description": "Object type", "enum": [ - "workspace" + "visualizationObject" ], - "example": "workspace", + "example": "visualizationObject", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspaceOutDocument": { + "JsonApiVisualizationObjectOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" }, "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$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": [ @@ -26863,12 +31129,12 @@ ], "type": "object" }, - "JsonApiWorkspaceOutList": { + "JsonApiVisualizationObjectOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" }, "type": "array", "uniqueItems": true @@ -26876,7 +31142,7 @@ "included": { "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutIncludes" }, "type": "array", "uniqueItems": true @@ -26888,6 +31154,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" @@ -26898,79 +31172,72 @@ ], "type": "object" }, - "JsonApiWorkspaceOutWithLinks": { + "JsonApiVisualizationObjectOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspacePatch": { - "description": "JSON:API representation of patching workspace entity.", + "JsonApiVisualizationObjectPatch": { + "description": "JSON:API representation of patching visualizationObject entity.", "properties": { "attributes": { "properties": { - "cacheExtraLimit": { - "format": "int64", - "type": "integer" + "areRelationsValid": { + "type": "boolean" }, - "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.", + "conditionalFormatting": { + "description": "Conditional formatting applied when this visualization is rendered.", + "nullable": true, "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", - "type": "string" + "enabled": { + "description": "Whether the rules are applied when rendering.", + "type": "boolean" }, - "schemaPath": { - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "rules": { + "description": "Rules evaluated in order; within a target, the first matching condition wins.", "items": { - "description": "The part of the schema path.", - "example": "subPath", - "type": "string" + "$ref": "#/components/schemas/ConditionalFormattingRule" }, "type": "array" } }, "required": [ - "id" + "enabled", + "rules" ], "type": "object" }, - "description": { - "maxLength": 255, - "nullable": true, - "type": "string" + "content": { + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, + "type": "object" }, - "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, + "description": { + "maxLength": 10000, "type": "string" }, - "earlyAccessValues": { - "description": "The early access feature identifiers. They are used to enable experimental features.", + "isHidden": { + "type": "boolean" + }, + "tags": { "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", + "title": { "maxLength": 255, - "nullable": true, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, @@ -26982,41 +31249,26 @@ "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" + "visualizationObject" ], - "example": "workspace", + "example": "visualizationObject", "type": "string" } }, "required": [ + "attributes", "id", "type" ], "type": "object" }, - "JsonApiWorkspacePatchDocument": { + "JsonApiVisualizationObjectPatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspacePatch" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" } }, "required": [ @@ -27024,75 +31276,68 @@ ], "type": "object" }, - "JsonApiWorkspaceSettingIn": { - "description": "JSON:API representation of workspaceSetting entity.", + "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 15000 characters.", - "example": {}, + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + }, "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], + "description": { + "maxLength": 10000, + "type": "string" + }, + "isHidden": { + "type": "boolean" + }, + "tags": { + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "maxLength": 255, "type": "string" } }, + "required": [ + "content" + ], "type": "object" }, "id": { @@ -27104,22 +31349,22 @@ "type": { "description": "Object type", "enum": [ - "workspaceSetting" + "visualizationObject" ], - "example": "workspaceSetting", + "example": "visualizationObject", "type": "string" } }, "required": [ - "id", + "attributes", "type" ], "type": "object" }, - "JsonApiWorkspaceSettingInDocument": { + "JsonApiVisualizationObjectPostOptionalIdDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" + "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" } }, "required": [ @@ -27127,73 +31372,262 @@ ], "type": "object" }, - "JsonApiWorkspaceSettingOut": { - "description": "JSON:API representation of workspaceSetting entity.", + "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": { - "content": { - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {}, + "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" }, - "type": { + "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": [ - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" + "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" @@ -27204,67 +31638,153 @@ "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "meta": { + "relationships": { "properties": { - "origin": { + "analyticalDashboard": { "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" + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ - "originId", - "originType" + "data" ], "type": "object" - } - }, - "type": "object" - }, - "type": { - "description": "Object type", - "enum": [ - "workspaceSetting" - ], - "example": "workspaceSetting", - "type": "string" - } - }, + }, + "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" }, - "JsonApiWorkspaceSettingOutDocument": { - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + "JsonApiWorkspaceAutomationOutIncludes": { + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + { + "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + }, + { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" } - }, - "required": [ - "data" - ], - "type": "object" + ] }, - "JsonApiWorkspaceSettingOutList": { + "JsonApiWorkspaceAutomationOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" }, "type": "array", "uniqueItems": true @@ -27276,6 +31796,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" @@ -27286,223 +31814,18 @@ ], "type": "object" }, - "JsonApiWorkspaceSettingOutWithLinks": { + "JsonApiWorkspaceAutomationOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], - "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.", + "JsonApiWorkspaceColorPaletteIn": { + "description": "JSON:API representation of workspaceColorPalette entity.", "properties": { "attributes": { "properties": { @@ -27531,9 +31854,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceTheme" + "workspaceColorPalette" ], - "example": "workspaceTheme", + "example": "workspaceColorPalette", "type": "string" } }, @@ -27544,10 +31867,10 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeInDocument": { + "JsonApiWorkspaceColorPaletteInDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteIn" } }, "required": [ @@ -27555,8 +31878,8 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOut": { - "description": "JSON:API representation of workspaceTheme entity.", + "JsonApiWorkspaceColorPaletteOut": { + "description": "JSON:API representation of workspaceColorPalette entity.", "properties": { "attributes": { "properties": { @@ -27611,9 +31934,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceTheme" + "workspaceColorPalette" ], - "example": "workspaceTheme", + "example": "workspaceColorPalette", "type": "string" } }, @@ -27624,10 +31947,10 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOutDocument": { + "JsonApiWorkspaceColorPaletteOutDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" @@ -27638,12 +31961,12 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOutList": { + "JsonApiWorkspaceColorPaletteOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOutWithLinks" }, "type": "array", "uniqueItems": true @@ -27665,18 +31988,18 @@ ], "type": "object" }, - "JsonApiWorkspaceThemeOutWithLinks": { + "JsonApiWorkspaceColorPaletteOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPaletteOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceThemePatch": { - "description": "JSON:API representation of patching workspaceTheme entity.", + "JsonApiWorkspaceColorPalettePatch": { + "description": "JSON:API representation of patching workspaceColorPalette entity.", "properties": { "attributes": { "properties": { @@ -27701,9 +32024,9 @@ "type": { "description": "Object type", "enum": [ - "workspaceTheme" + "workspaceColorPalette" ], - "example": "workspaceTheme", + "example": "workspaceColorPalette", "type": "string" } }, @@ -27714,10 +32037,10 @@ ], "type": "object" }, - "JsonApiWorkspaceThemePatchDocument": { + "JsonApiWorkspaceColorPalettePatchDocument": { "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" + "$ref": "#/components/schemas/JsonApiWorkspaceColorPalettePatch" } }, "required": [ @@ -27725,37 +32048,54 @@ ], "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" - }, - "LabelIdentifier": { - "description": "A label identifier.", + "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": "Label ID.", - "example": "label_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": "A type of the label.", + "description": "Object type", "enum": [ - "label" + "workspaceDataFilter" ], - "example": "label", + "example": "workspaceDataFilter", "type": "string" } }, @@ -27765,1591 +32105,2052 @@ ], "type": "object" }, - "LabelPermissions": { + "JsonApiWorkspaceDataFilterInDocument": { "properties": { - "rules": { - "description": "List of rules", - "items": { - "$ref": "#/components/schemas/RulePermission" - }, - "type": "array" - }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" - }, - "type": "array" - }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" - }, - "type": "array" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" } }, "required": [ - "rules", - "userGroups", - "users" + "data" ], "type": "object" }, - "LabelPermissionsAssignment": { - "description": "Desired levels of permissions on a label for an assignee.", + "JsonApiWorkspaceDataFilterLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { - "permissions": { - "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" - }, - "type": "array" + "id": { + "type": "string" + }, + "type": { + "enum": [ + "workspaceDataFilter" + ], + "type": "string" } }, "required": [ - "permissions" + "id", + "type" ], "type": "object" }, - "LabelPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsAssignment" - }, - { - "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "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" - } - ], - "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": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" + "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" } - ], - "description": "Desired levels of label permissions for a collection of assignees identified by a rule.", + }, "required": [ - "assigneeRule", - "permissions" + "id", + "type" ], "type": "object" }, - "ListLinks": { - "allOf": [ - { + "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": { - "next": { - "description": "A string containing the link's URL for the next page of data.", - "format": "uri", - "type": "string" + "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" }, - "LiveFeatureFlagConfiguration": { + "JsonApiWorkspaceDataFilterOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "host": { - "type": "string" + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, - "key": { - "type": "string" + "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": [ - "host", - "key" + "data" ], "type": "object" }, - "LiveFeatures": { + "JsonApiWorkspaceDataFilterOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/Features" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" }, { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiWorkspaceDataFilterPatch": { + "description": "JSON:API representation of patching workspaceDataFilter entity.", + "properties": { + "attributes": { "properties": { - "configuration": { - "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" + "columnName": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "title": { + "maxLength": 255, + "type": "string" } }, "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", + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "title": { - "description": "Metric title.", - "example": "Revenue", - "maxLength": 255, - "nullable": true, + "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": [ - "localIdentifier" + "id", + "type" ], "type": "object" }, - "LocaleRequest": { + "JsonApiWorkspaceDataFilterPatchDocument": { "properties": { - "locale": { - "description": "Requested locale in the form of language tag (see RFC 5646).", - "example": "en-US", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" } }, "required": [ - "locale" + "data" ], "type": "object" }, - "MatchAttributeFilter": { - "description": "Filter via label with given match type and literal value.", + "JsonApiWorkspaceDataFilterSettingIn": { + "description": "JSON:API representation of workspaceDataFilterSetting entity.", "properties": { - "matchAttributeFilter": { + "attributes": { "properties": { - "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", + "description": { + "maxLength": 10000, "type": "string" }, - "localIdentifier": { - "type": "string" + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" }, - "matchType": { - "description": "Requested match type.", - "enum": [ - "STARTS_WITH", - "ENDS_WITH", - "CONTAINS" - ], + "title": { + "maxLength": 255, "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.", + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "siteId": { - "description": "Site ID on telemetry server.", - "format": "int32", - "type": "integer" + "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": [ - "host", - "siteId" + "id", + "type" ], "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" + "JsonApiWorkspaceDataFilterSettingInDocument": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" } + }, + "required": [ + "data" ], "type": "object" }, - "MeasureItem": { - "description": "Metric is a quantity that is calculated from the data.", + "JsonApiWorkspaceDataFilterSettingLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { - "definition": { - "$ref": "#/components/schemas/MeasureDefinition" + "id": { + "type": "string" }, - "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": [ + "workspaceDataFilterSetting" + ], "type": "string" } }, "required": [ - "definition", - "localIdentifier" + "id", + "type" ], "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" + "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" }, - { - "$ref": "#/components/schemas/RangeCondition" - } - ], - "type": "object" - }, - "MeasureValueFilter": { - "description": "Abstract filter definition type filtering by the value of the metric.", - "oneOf": [ - { - "$ref": "#/components/schemas/ComparisonMeasureValueFilter" + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" }, - { - "$ref": "#/components/schemas/RangeMeasureValueFilter" + "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" }, - { - "$ref": "#/components/schemas/CompoundMeasureValueFilter" - } - ], - "type": "object" - }, - "MetricDefinitionOverride": { - "description": "(EXPERIMENTAL) Override for a catalog metric definition.", - "properties": { - "definition": { - "$ref": "#/components/schemas/InlineMeasureDefinition" + "relationships": { + "properties": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } + }, + "type": "object" }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "type": { + "description": "Object type", + "enum": [ + "workspaceDataFilterSetting" + ], + "example": "workspaceDataFilterSetting", + "type": "string" } }, "required": [ - "definition", - "item" + "id", + "type" ], "type": "object" }, - "MetricPermissions": { + "JsonApiWorkspaceDataFilterSettingOutDocument": { "properties": { - "rules": { - "description": "List of rules", + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, + "included": { + "description": "Included resources", "items": { - "$ref": "#/components/schemas/RulePermission" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, - "type": "array" + "type": "array", + "uniqueItems": true }, - "userGroups": { - "description": "List of user groups", - "items": { - "$ref": "#/components/schemas/UserGroupPermission" - }, - "type": "array" + "links": { + "$ref": "#/components/schemas/ObjectLinks" }, - "users": { - "description": "List of users", - "items": { - "$ref": "#/components/schemas/UserPermission" + "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": "array" + "type": "object" } }, "required": [ - "rules", - "userGroups", - "users" + "data" ], "type": "object" }, - "MetricPermissionsAssignment": { - "description": "Desired levels of permissions on a metric for an assignee.", + "JsonApiWorkspaceDataFilterSettingOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "permissions": { + "data": { "items": { - "enum": [ - "EDIT", - "SHARE", - "VIEW" - ], - "type": "string" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, - "type": "array" - } - }, - "required": [ - "permissions" - ], - "type": "object" - }, - "MetricPermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsAssignment" + "type": "array", + "uniqueItems": true }, - { + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + }, + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "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" } - ], - "description": "Desired levels of metric permissions for an assignee identified by an identifier.", + }, "required": [ - "assigneeIdentifier", - "permissions" + "data" ], "type": "object" }, - "MetricPermissionsForAssigneeRule": { + "JsonApiWorkspaceDataFilterSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/MetricPermissionsAssignment" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" }, { - "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" - } - }, - "type": "object" + "$ref": "#/components/schemas/ObjectLinksContainer" } - ], - "description": "Desired levels of metric permissions for a collection of assignees identified by a rule.", - "required": [ - "assigneeRule", - "permissions" - ], - "type": "object" + ] }, - "NegativeAttributeFilter": { - "description": "Filter able to limit element values by label and related selected negated elements.", + "JsonApiWorkspaceDataFilterSettingPatch": { + "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", "properties": { - "negativeAttributeFilter": { + "attributes": { "properties": { - "applyOnResult": { - "type": "boolean" - }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "localIdentifier": { + "description": { + "maxLength": 10000, "type": "string" }, - "notIn": { - "$ref": "#/components/schemas/AttributeFilterElements" + "filterValues": { + "items": { + "type": "string" + }, + "type": "array" }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + "title": { + "maxLength": 255, + "type": "string" } }, - "required": [ - "label", - "notIn" - ], "type": "object" - } - }, - "required": [ - "negativeAttributeFilter" - ], - "type": "object" - }, - "Note": { - "properties": { - "appliesTo": { - "enum": [ - "SOURCE", - "TARGET" - ], - "type": "string", - "xml": { - "attribute": true - } - }, - "category": { - "type": "string", - "xml": { - "attribute": true - } - }, - "content": { - "type": "string" }, "id": { - "type": "string", - "xml": { - "attribute": true - } + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" }, - "otherAttributes": { - "additionalProperties": { - "type": "string" + "relationships": { + "properties": { + "workspaceDataFilter": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, "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": [ - "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" - }, - "NumberConstraints": { - "properties": { - "max": { - "format": "double", - "type": "number" - }, - "min": { - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "NumberParameterDefinition": { - "properties": { - "constraints": { - "$ref": "#/components/schemas/NumberConstraints" - }, - "defaultValue": { - "format": "double", - "type": "number" - }, "type": { - "description": "The parameter type.", + "description": "Object type", "enum": [ - "NUMBER" + "workspaceDataFilterSetting" ], + "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ - "defaultValue", + "id", "type" ], "type": "object" }, - "ObjectLinks": { + "JsonApiWorkspaceDataFilterSettingPatchDocument": { "properties": { - "self": { - "description": "A string containing the link's URL.", - "format": "uri", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" } }, "required": [ - "self" + "data" ], "type": "object" }, - "ObjectLinksContainer": { - "properties": { - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } + "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": "object" + "type": "array" }, - "OpenAIProviderConfig": { - "description": "Configuration for OpenAI provider.", - "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.", - "enum": [ - "OPENAI" - ], - "type": "string" - } + "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" }, - "required": [ - "auth", - "type" - ], - "type": "object" + "type": "array" }, - "OpenAiApiKeyAuth": { - "allOf": [ + "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": { - "apiKey": { - "description": "OpenAI API key.", - "maxLength": 255, + "dashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, - "type": "string", - "writeOnly": true - }, - "type": { - "description": "Authentication type.", - "enum": [ - "API_KEY" + "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" - } - ], - "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" - }, - "OrganizationAutomationIdentifier": { - "properties": { + }, "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "workspaceId": { + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ + "attributes", "id", - "workspaceId" - ], - "type": "object" - }, - "OrganizationAutomationManagementBulkRequest": { - "properties": { - "automations": { - "items": { - "$ref": "#/components/schemas/OrganizationAutomationIdentifier" - }, - "type": "array" - } - }, - "required": [ - "automations" + "type" ], "type": "object" }, - "OrganizationPermissionAssignment": { - "description": "Organization permission assignments", + "JsonApiWorkspaceExportTemplateInDocument": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" - }, - "type": "array" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateIn" } }, "required": [ - "assigneeIdentifier", - "permissions" + "data" ], "type": "object" }, - "Over": { + "JsonApiWorkspaceExportTemplateOut": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { "attributes": { - "items": { - "$ref": "#/components/schemas/IdentifierRef" - }, - "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" + "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" }, - "totalPages": { - "description": "The total number of pages", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Parameter": { - "properties": { - "name": { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "value": { + "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": [ - "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" - } + "attributes", + "id", + "type" ], "type": "object" }, - "ParameterItem": { - "additionalProperties": true, - "description": "(EXPERIMENTAL) Parameter value for this execution.", + "JsonApiWorkspaceExportTemplateOutDocument": { "properties": { - "parameter": { - "$ref": "#/components/schemas/AfmObjectIdentifierParameter" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" }, - "value": { - "description": "Value to use for this parameter instead of its default.", - "type": "string" + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ - "parameter", - "value" + "data" ], "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.", + "JsonApiWorkspaceExportTemplateOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "id": { - "description": "Identifier of the workspace parameter (matches the parameter entity id).", - "example": "year", - "type": "string" + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOutWithLinks" + }, + "type": "array", + "uniqueItems": true }, - "title": { - "description": "Display title of the parameter as the client wants it rendered on the info sheet.", - "example": "Year", - "type": "string" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "value": { - "description": "Value to use for this parameter when executing the export.", - "example": "2026", - "type": "string" + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, "required": [ - "id", - "title", - "value" + "data" ], "type": "object" }, - "PdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ + "JsonApiWorkspaceExportTemplateOutWithLinks": { + "allOf": [ { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" - } - ], - "properties": { - "properties": { - "description": "List of CSS properties.", - "items": { - "$ref": "#/components/schemas/PdfTableStyleProperty" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplateOut" }, - "selector": { - "description": "CSS selector where to apply given properties.", - "type": "string" + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - }, - "required": [ - "selector" - ], - "type": "object" + ] }, - "PdfTableStyleProperty": { - "description": "CSS property.", + "JsonApiWorkspaceExportTemplatePatch": { + "description": "JSON:API representation of patching workspaceExportTemplate entity.", "properties": { - "key": { - "description": "CSS property key.", + "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" }, - "value": { - "description": "CSS property value.", + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ - "key", - "value" + "attributes", + "id", + "type" ], "type": "object" }, - "PdmLdmRequest": { - "description": "PDM additions wrapper.", + "JsonApiWorkspaceExportTemplatePatchDocument": { "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" - }, - "tables": { - "description": "List of physical database tables.", - "items": { - "$ref": "#/components/schemas/DeclarativeTable" - }, - "type": "array" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePatch" } }, + "required": [ + "data" + ], "type": "object" }, - "PdmSql": { - "description": "SQL dataset definition.", + "JsonApiWorkspaceExportTemplatePostOptionalId": { + "description": "JSON:API representation of workspaceExportTemplate entity.", "properties": { - "columns": { - "description": "Columns defining SQL dataset.", - "items": { - "$ref": "#/components/schemas/SqlColumn" + "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": "array" + "required": [ + "name" + ], + "type": "object" }, - "statement": { - "description": "SQL statement.", - "example": "select * from abc", + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "title": { - "description": "SQL dataset title.", - "example": "My special dataset", + "type": { + "description": "Object type", + "enum": [ + "workspaceExportTemplate" + ], + "example": "workspaceExportTemplate", "type": "string" } }, "required": [ - "statement", - "title" + "attributes", + "type" ], "type": "object" }, - "PermissionsAssignment": { + "JsonApiWorkspaceExportTemplatePostOptionalIdDocument": { "properties": { - "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" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceExportTemplatePostOptionalId" } }, "required": [ - "assignees" + "data" ], "type": "object" }, - "PermissionsForAssignee": { - "allOf": [ - { - "$ref": "#/components/schemas/DashboardPermissionsAssignment" - }, - { + "JsonApiWorkspaceIn": { + "description": "JSON:API representation of workspace entity.", + "properties": { + "attributes": { "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - } + "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" - } - ], - "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" + }, + "relationships": { "properties": { - "assigneeRule": { - "$ref": "#/components/schemas/AssigneeRule" + "parent": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" } }, "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": { + "type": { + "description": "Object type", "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" + "workspace" ], + "example": "workspace", "type": "string" } }, "required": [ - "name" + "id", + "type" ], "type": "object" }, - "PlatformUsageRequest": { + "JsonApiWorkspaceInDocument": { "properties": { - "usageItemNames": { - "items": { - "enum": [ - "UserCount", - "WorkspaceCount", - "AiWorkspaceCount" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceIn" } }, "required": [ - "usageItemNames" + "data" ], "type": "object" }, - "PopDataset": { - "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", + "JsonApiWorkspaceLinkage": { + "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + "id": { + "type": "string" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "type": { + "enum": [ + "workspace" + ], + "type": "string" } }, "required": [ - "dataset", - "periodsAgo" + "id", + "type" ], "type": "object" }, - "PopDatasetMeasureDefinition": { - "description": "Previous period type of metric.", + "JsonApiWorkspaceOut": { + "description": "JSON:API representation of workspace entity.", "properties": { - "previousPeriodMeasure": { + "attributes": { "properties": { - "dateDatasets": { - "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", + "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": { - "$ref": "#/components/schemas/PopDataset" + "maxLength": 255, + "type": "string" }, + "nullable": true, "type": "array" }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "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" } }, - "required": [ - "dateDatasets", - "measureIdentifier" - ], "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspace" + ], + "example": "workspace", + "type": "string" } }, "required": [ - "previousPeriodMeasure" + "id", + "type" ], "type": "object" }, - "PopDate": { - "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", + "JsonApiWorkspaceOutDocument": { "properties": { - "attribute": { - "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, - "periodsAgo": { - "description": "Number of periods ago to calculate the previous period for.", - "example": 1, - "format": "int32", - "type": "integer" + "included": { + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + }, + "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": [ - "attribute", - "periodsAgo" + "data" ], "type": "object" }, - "PopDateMeasureDefinition": { - "description": "Period over period type of metric.", + "JsonApiWorkspaceOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "overPeriodMeasure": { + "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" + }, + "meta": { "properties": { - "dateAttributes": { - "description": "Attributes to use for determining the period to calculate the PoP for.", + "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/PopDate" + "$ref": "#/components/schemas/RestrictedObject" }, - "type": "array" - }, - "measureIdentifier": { - "$ref": "#/components/schemas/AfmLocalIdentifier" + "type": "array", + "uniqueItems": true } }, - "required": [ - "dateAttributes", - "measureIdentifier" - ], "type": "object" } }, "required": [ - "overPeriodMeasure" + "data" ], "type": "object" }, - "PopMeasureDefinition": { - "oneOf": [ + "JsonApiWorkspaceOutWithLinks": { + "allOf": [ { - "$ref": "#/components/schemas/PopDatasetMeasureDefinition" + "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, { - "$ref": "#/components/schemas/PopDateMeasureDefinition" + "$ref": "#/components/schemas/ObjectLinksContainer" } - ], - "type": "object" + ] }, - "PositiveAttributeFilter": { - "description": "Filter able to limit element values by label and related selected elements.", + "JsonApiWorkspacePatch": { + "description": "JSON:API representation of patching workspace entity.", "properties": { - "positiveAttributeFilter": { + "attributes": { "properties": { - "applyOnResult": { - "type": "boolean" + "cacheExtraLimit": { + "format": "int64", + "type": "integer" }, - "in": { - "$ref": "#/components/schemas/AttributeFilterElements" + "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" }, - "label": { - "$ref": "#/components/schemas/AfmIdentifier" + "description": { + "maxLength": 255, + "nullable": true, + "type": "string" }, - "localIdentifier": { + "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" }, - "usesArbitraryValues": { - "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", - "type": "boolean" + "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" } }, - "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" }, - "features": { - "oneOf": [ - { - "$ref": "#/components/schemas/LiveFeatures" - }, - { - "$ref": "#/components/schemas/StaticFeatures" - } - ] - }, - "links": { - "$ref": "#/components/schemas/ProfileLinks" - }, - "name": { - "type": "string" - }, - "organizationId": { - "type": "string" - }, - "organizationName": { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "permissions": { - "items": { - "enum": [ - "MANAGE", - "SELF_CREATE_TOKEN", - "BASE_UI_ACCESS" - ], - "type": "string" + "relationships": { + "properties": { + "parent": { + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + }, + "required": [ + "data" + ], + "type": "object" + } }, - "type": "array" - }, - "telemetryConfig": { - "$ref": "#/components/schemas/TelemetryConfig" + "type": "object" }, - "userId": { + "type": { + "description": "Object type", + "enum": [ + "workspace" + ], + "example": "workspace", "type": "string" } }, "required": [ - "entitlements", - "features", - "links", - "organizationId", - "organizationName", - "permissions", - "telemetryConfig", - "userId" + "id", + "type" ], "type": "object" }, - "ProfileLinks": { + "JsonApiWorkspacePatchDocument": { "properties": { - "organization": { - "type": "string" - }, - "self": { - "type": "string" - }, - "user": { - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspacePatch" } }, "required": [ - "organization", - "self", - "user" + "data" ], "type": "object" }, - "Range": { + "JsonApiWorkspaceSettingIn": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { - "from": { - "$ref": "#/components/schemas/Value" + "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" }, - "measure": { - "$ref": "#/components/schemas/LocalIdentifier" + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" }, - "operator": { + "type": { + "description": "Object type", "enum": [ - "BETWEEN", - "NOT_BETWEEN" + "workspaceSetting" ], + "example": "workspaceSetting", "type": "string" - }, - "to": { - "$ref": "#/components/schemas/Value" } }, "required": [ - "from", - "measure", - "operator", - "to" + "id", + "type" ], "type": "object" }, - "RangeCondition": { - "description": "Condition that checks if the metric value is within a given range.", + "JsonApiWorkspaceSettingInDocument": { "properties": { - "range": { - "properties": { - "from": { - "example": 100, - "type": "number" - }, - "operator": { - "enum": [ - "BETWEEN", - "NOT_BETWEEN" - ], - "example": "BETWEEN", - "type": "string" - }, - "to": { - "example": 999, - "type": "number" - } - }, - "required": [ - "from", - "operator", - "to" - ], - "type": "object" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" } }, "required": [ - "range" + "data" ], "type": "object" }, - "RangeMeasureValueFilter": { - "description": "Filter the result by comparing specified metric to given range of values.", + "JsonApiWorkspaceSettingOut": { + "description": "JSON:API representation of workspaceSetting entity.", "properties": { - "rangeMeasureValueFilter": { + "attributes": { "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "from": { - "example": 100, - "type": "number" - }, - "localIdentifier": { - "type": "string" - }, - "measure": { - "$ref": "#/components/schemas/AfmIdentifier" + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "operator": { + "type": { "enum": [ - "BETWEEN", - "NOT_BETWEEN" + "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" ], - "example": "BETWEEN", "type": "string" - }, - "to": { - "example": 999, - "type": "number" - }, - "treatNullValuesAs": { - "description": "A value that will be substituted for null values in the metric for the comparisons.", - "example": 0, - "type": "number" } }, - "required": [ - "from", - "measure", - "operator", - "to" - ], "type": "object" - } - }, - "required": [ - "rangeMeasureValueFilter" - ], - "type": "object" - }, - "RangeWrapper": { - "properties": { - "range": { - "$ref": "#/components/schemas/Range" - } - }, - "required": [ - "range" - ], - "type": "object" - }, - "RankingFilter": { - "description": "Filter the result on top/bottom N values according to given metric(s).", - "properties": { - "rankingFilter": { + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { "properties": { - "applyOnResult": { - "type": "boolean" - }, - "dimensionality": { - "description": "References to the attributes to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" - }, - "type": "array" - }, - "localIdentifier": { - "type": "string" - }, - "measures": { - "description": "References to the metrics to be used when filtering.", - "items": { - "$ref": "#/components/schemas/AfmIdentifier" + "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" + } }, - "type": "array" - }, - "operator": { - "description": "The type of ranking to use, TOP or BOTTOM.", - "enum": [ - "TOP", - "BOTTOM" + "required": [ + "originId", + "originType" ], - "type": "string" - }, - "strictLimitOfRows": { - "description": "When true, filter returns requested number of rows at most. Default is false.", - "type": "boolean" - }, - "value": { - "description": "Number of top/bottom values to filter.", - "example": 5, - "format": "int32", - "type": "integer" + "type": "object" } }, - "required": [ - "measures", - "operator", - "value" - ], "type": "object" - } - }, - "required": [ - "rankingFilter" - ], - "type": "object" - }, - "RawCustomLabel": { - "description": "Custom label object override.", - "properties": { - "title": { - "description": "Override value.", + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceSetting" + ], + "example": "workspaceSetting", "type": "string" } }, "required": [ - "title" + "id", + "type" ], "type": "object" }, - "RawCustomMetric": { - "description": "Custom metric object override.", + "JsonApiWorkspaceSettingOutDocument": { "properties": { - "title": { - "description": "Metric title override.", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ - "title" + "data" ], "type": "object" }, - "RawCustomOverride": { - "description": "Custom cell value overrides (IDs will be replaced with specified values).", + "JsonApiWorkspaceSettingOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "labels": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomLabel" + "data": { + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" }, - "description": "Map of CustomLabels with keys used as placeholders in export result.", - "type": "object" + "type": "array", + "uniqueItems": true }, - "metrics": { - "additionalProperties": { - "$ref": "#/components/schemas/RawCustomMetric" + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } }, - "description": "Map of CustomMetrics with keys used as placeholders in export result.", "type": "object" } }, + "required": [ + "data" + ], "type": "object" }, - "RawExportAutomationRequest": { - "description": "Export request object describing the export properties and overrides for raw exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/RawCustomOverride" - }, - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", - "type": "string" - }, - "execution": { - "$ref": "#/components/schemas/AFM" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "ARROW_FILE", - "ARROW_STREAM", - "CSV" - ], - "example": "CSV", - "type": "string" + "JsonApiWorkspaceSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - }, - "required": [ - "execution", - "fileName", - "format" - ], - "type": "object" + ] }, - "ReferenceIdentifier": { - "description": "A reference identifier.", + "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": "Reference ID.", - "example": "customers", + "description": "API identifier of an object", + "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { - "description": "A type of the reference.", + "description": "Object type", "enum": [ - "dataset" + "workspaceSetting" ], - "example": "DATASET", + "example": "workspaceSetting", "type": "string" } }, @@ -29359,1262 +34160,1141 @@ ], "type": "object" }, - "ReferenceSourceColumn": { + "JsonApiWorkspaceSettingPatchDocument": { "properties": { - "column": { + "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" }, - "dataType": { + "type": { + "description": "Object type", "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN", - "HLL" + "workspaceSetting" ], + "example": "workspaceSetting", "type": "string" - }, - "isNullable": { - "type": "boolean" - }, - "nullValue": { - "type": "string" - }, - "target": { - "$ref": "#/components/schemas/DatasetGrain" } }, "required": [ - "target" + "type" ], "type": "object" }, - "Relative": { + "JsonApiWorkspaceSettingPostOptionalIdDocument": { "properties": { - "measure": { - "$ref": "#/components/schemas/ArithmeticMeasure" - }, - "operator": { - "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", - "enum": [ - "INCREASES_BY", - "DECREASES_BY", - "CHANGES_BY" - ], - "type": "string" - }, - "threshold": { - "$ref": "#/components/schemas/Value" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" } }, "required": [ - "measure", - "operator", - "threshold" + "data" ], "type": "object" }, - "RelativeBoundedDateFilter": { + "JsonApiWorkspaceThemeIn": { + "description": "JSON:API representation of workspaceTheme entity.", "properties": { - "from": { - "format": "int32", - "type": "integer" + "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" }, - "granularity": { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "Object type", "enum": [ - "ALL_TIME_GRANULARITY", - "GDC.time.year", - "GDC.time.week_us", - "GDC.time.week_in_year", - "GDC.time.week_in_quarter", - "GDC.time.week", - "GDC.time.euweek_in_year", - "GDC.time.euweek_in_quarter", - "GDC.time.quarter", - "GDC.time.quarter_in_year", - "GDC.time.month", - "GDC.time.month_in_quarter", - "GDC.time.month_in_year", - "GDC.time.day_in_year", - "GDC.time.day_in_quarter", - "GDC.time.day_in_month", - "GDC.time.day_in_week", - "GDC.time.day_in_euweek", - "GDC.time.date", - "GDC.time.hour", - "GDC.time.hour_in_day", - "GDC.time.minute", - "GDC.time.minute_in_hour", - "GDC.time.minute_in_day", - "GDC.time.second", - "GDC.time.second_in_minute", - "GDC.time.second_in_day", - "GDC.time.fiscal_week", - "GDC.time.fiscal_month", - "GDC.time.fiscal_quarter", - "GDC.time.fiscal_semester", - "GDC.time.fiscal_year", - "GDC.time.fiscal_day_in_fiscal_week", - "GDC.time.fiscal_day_in_fiscal_month", - "GDC.time.fiscal_day_in_fiscal_quarter", - "GDC.time.fiscal_day_in_fiscal_semester", - "GDC.time.fiscal_day_in_fiscal_year", - "GDC.time.fiscal_week_in_fiscal_month", - "GDC.time.fiscal_week_in_fiscal_quarter", - "GDC.time.fiscal_week_in_fiscal_semester", - "GDC.time.fiscal_week_in_fiscal_year", - "GDC.time.fiscal_month_in_fiscal_quarter", - "GDC.time.fiscal_month_in_fiscal_semester", - "GDC.time.fiscal_month_in_fiscal_year", - "GDC.time.fiscal_quarter_in_fiscal_semester", - "GDC.time.fiscal_quarter_in_fiscal_year", - "GDC.time.fiscal_semester_in_fiscal_year" + "workspaceTheme" ], + "example": "workspaceTheme", "type": "string" - }, - "to": { - "format": "int32", - "type": "integer" } }, "required": [ - "granularity" + "attributes", + "id", + "type" ], "type": "object" }, - "RelativeDateFilter": { - "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", + "JsonApiWorkspaceThemeInDocument": { "properties": { - "relativeDateFilter": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeIn" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "JsonApiWorkspaceThemeOut": { + "description": "JSON:API representation of workspaceTheme entity.", + "properties": { + "attributes": { "properties": { - "applyOnResult": { - "type": "boolean" - }, - "boundedFilter": { - "$ref": "#/components/schemas/BoundedFilter" - }, - "dataset": { - "$ref": "#/components/schemas/AfmObjectIdentifierDataset" - }, - "emptyValueHandling": { - "default": "EXCLUDE", - "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", - "enum": [ - "INCLUDE", - "EXCLUDE", - "ONLY" - ], - "type": "string" - }, - "from": { - "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", - "example": -6, - "format": "int32", - "type": "integer" - }, - "granularity": { - "description": "Date granularity specifying particular date attribute in given dimension.", - "enum": [ - "SECOND", - "SECOND_OF_MINUTE", - "SECOND_OF_DAY", - "MINUTE", - "MINUTE_OF_HOUR", - "MINUTE_OF_DAY", - "HOUR", - "HOUR_OF_DAY", - "DAY", - "DAY_OF_WEEK", - "DAY_OF_MONTH", - "DAY_OF_QUARTER", - "DAY_OF_YEAR", - "WEEK", - "WEEK_OF_YEAR", - "MONTH", - "MONTH_OF_YEAR", - "QUARTER", - "QUARTER_OF_YEAR", - "YEAR", - "FISCAL_DAY_OF_FISCAL_WEEK", - "FISCAL_DAY_OF_FISCAL_MONTH", - "FISCAL_DAY_OF_FISCAL_QUARTER", - "FISCAL_DAY_OF_FISCAL_SEMESTER", - "FISCAL_DAY_OF_FISCAL_YEAR", - "FISCAL_WEEK", - "FISCAL_WEEK_OF_FISCAL_MONTH", - "FISCAL_WEEK_OF_FISCAL_QUARTER", - "FISCAL_WEEK_OF_FISCAL_SEMESTER", - "FISCAL_WEEK_OF_FISCAL_YEAR", - "FISCAL_MONTH", - "FISCAL_MONTH_OF_FISCAL_QUARTER", - "FISCAL_MONTH_OF_FISCAL_SEMESTER", - "FISCAL_MONTH_OF_FISCAL_YEAR", - "FISCAL_QUARTER", - "FISCAL_QUARTER_OF_FISCAL_SEMESTER", - "FISCAL_QUARTER_OF_FISCAL_YEAR", - "FISCAL_SEMESTER", - "FISCAL_SEMESTER_OF_FISCAL_YEAR", - "FISCAL_YEAR" - ], - "example": "DAY", - "type": "string" + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" }, - "localIdentifier": { + "name": { + "maxLength": 255, "type": "string" - }, - "to": { - "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", - "example": 0, - "format": "int32", - "type": "integer" } }, "required": [ - "dataset", - "from", - "granularity", - "to" + "content", + "name" ], "type": "object" + }, + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "meta": { + "properties": { + "origin": { + "properties": { + "originId": { + "description": "defines id of the workspace where the entity comes from", + "type": "string" + }, + "originType": { + "description": "defines type of the origin of the entity", + "enum": [ + "NATIVE", + "PARENT" + ], + "type": "string" + } + }, + "required": [ + "originId", + "originType" + ], + "type": "object" + } + }, + "type": "object" + }, + "type": { + "description": "Object type", + "enum": [ + "workspaceTheme" + ], + "example": "workspaceTheme", + "type": "string" } }, "required": [ - "relativeDateFilter" + "attributes", + "id", + "type" ], "type": "object" }, - "RelativeWrapper": { + "JsonApiWorkspaceThemeOutDocument": { "properties": { - "relative": { - "$ref": "#/components/schemas/Relative" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ - "relative" + "data" ], "type": "object" }, - "ResolveSettingsRequest": { - "description": "A request containing setting IDs to resolve.", + "JsonApiWorkspaceThemeOutList": { + "description": "A JSON:API document with a list of resources", "properties": { - "settings": { - "description": "An array of setting IDs to resolve.", - "example": [ - "timezone" - ], + "data": { "items": { - "type": "string" + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOutWithLinks" }, - "type": "array" + "type": "array", + "uniqueItems": true + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + }, + "type": "object" } }, "required": [ - "settings" + "data" ], "type": "object" }, - "ResolvedSetting": { - "description": "Setting and its value.", - "properties": { - "content": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "deprecated": true, - "description": "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", - "type": "string" + "JsonApiWorkspaceThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceThemeOut" }, - "type": { - "description": "Type of the setting.", - "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", - "SORT_CASE_SENSITIVE", - "SORT_COLLATION", - "METRIC_FORMAT_OVERRIDE", - "ENABLE_AI_ON_DATA", - "ENABLE_PARTIAL_DATA_RESULTS", - "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", - "ENABLE_NULL_JOINS", - "EXPORT_CSV_CUSTOM_DELIMITER", - "ENABLE_QUERY_TAGS", - "RESTRICT_BASE_UI", - "CERTIFY_PARENT_OBJECTS", - "HLL_TYPE" - ], - "example": "TIMEZONE", - "type": "string" + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - }, - "required": [ - "id" - ], - "type": "object" + ] }, - "RsaSpecification": { + "JsonApiWorkspaceThemePatch": { + "description": "JSON:API representation of patching workspaceTheme entity.", "properties": { - "alg": { - "enum": [ - "RS256", - "RS384", - "RS512" - ], - "type": "string" - }, - "e": { - "type": "string" - }, - "kid": { - "maxLength": 255, - "minLength": 0, - "pattern": "^[^.]", - "type": "string" - }, - "kty": { - "enum": [ - "RSA" - ], - "type": "string" + "attributes": { + "properties": { + "content": { + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {}, + "type": "object" + }, + "name": { + "maxLength": 255, + "type": "string" + } + }, + "type": "object" }, - "n": { + "id": { + "description": "API identifier of an object", + "example": "id1", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "use": { + "type": { + "description": "Object type", "enum": [ - "sig" + "workspaceTheme" ], - "type": "string" - }, - "x5c": { - "items": { - "type": "string" - }, - "type": "array" - }, - "x5t": { + "example": "workspaceTheme", "type": "string" } }, "required": [ - "alg", - "e", - "kid", - "kty", - "n", - "use" + "attributes", + "id", + "type" ], "type": "object" }, - "RulePermission": { - "description": "List of rules", + "JsonApiWorkspaceThemePatchDocument": { "properties": { - "permissions": { - "description": "Permissions granted by the rule", - "items": { - "$ref": "#/components/schemas/GrantedPermission" - }, - "type": "array" - }, - "type": { - "description": "Type of the rule", - "example": "allWorkspaceUsers", - "type": "string" + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceThemePatch" } }, "required": [ - "type" + "data" ], "type": "object" }, - "RunningSection": { - "description": "Footer section of the slide", + "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, - "properties": { - "left": { - "description": "Either {{logo}} variable or custom text with combination of other variables.", - "nullable": true, - "type": "string" - }, - "right": { - "description": "Either {{logo}} variable or custom text with combination of other variables.", - "nullable": true, - "type": "string" + "oneOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" } - }, + ] + }, + "JsonNode": { + "description": "Free-form JSON object", + "example": {}, + "maxLength": 15000, + "nullable": true, "type": "object" }, - "ScheduleCacheRetention": { - "description": "The cache expires according to a schedule.", + "LabelIdentifier": { + "description": "A label identifier.", "properties": { - "schedule": { - "$ref": "#/components/schemas/CacheRetentionSchedule" + "id": { + "description": "Label ID.", + "example": "label_id", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" }, "type": { - "description": "The cache retention type.", + "description": "A type of the label.", "enum": [ - "SCHEDULE" + "label" ], + "example": "label", "type": "string" } }, "required": [ - "schedule", + "id", "type" ], "type": "object" }, - "SectionSlideTemplate": { - "description": "Settings for section slide.", - "nullable": true, + "LabelPermissions": { "properties": { - "backgroundImage": { - "default": true, - "description": "Show background image on the slide.", - "type": "boolean" + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" }, - "footer": { - "$ref": "#/components/schemas/RunningSection" + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" }, - "header": { - "$ref": "#/components/schemas/RunningSection" + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" } }, + "required": [ + "rules", + "userGroups", + "users" + ], "type": "object" }, - "SetCertificationRequest": { - "description": "Request to set or clear the certification of a workspace entity.", + "LabelPermissionsAssignment": { + "description": "Desired levels of permissions on a label for an assignee.", "properties": { - "id": { - "description": "ID of the entity.", - "example": "total-sales", - "type": "string" - }, - "message": { - "description": "Optional message associated with the certification.", - "nullable": true, - "type": "string" - }, - "status": { - "description": "Certification status of the entity.", - "enum": [ - "CERTIFIED" - ], - "nullable": true, - "type": "string" - }, - "type": { - "description": "Type of the entity.", - "enum": [ - "metric", - "visualizationObject", - "analyticalDashboard" - ], - "type": "string" + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" } }, "required": [ - "id", - "type" + "permissions" ], "type": "object" }, - "Settings": { - "description": "Additional settings.", - "properties": { - "delimiter": { - "description": "Set column delimiter. (CSV)", - "maxLength": 1, - "minLength": 1, - "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", - "type": "string" - }, - "exportInfo": { - "default": false, - "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", - "example": true, - "type": "boolean" - }, - "grandTotalsPosition": { - "description": "Grand totals position. Takes precedence over position specified in visualization.", - "enum": [ - "pinnedBottom", - "pinnedTop", - "bottom", - "top" - ], - "type": "string" - }, - "mergeHeaders": { - "description": "Merge equal headers in neighbouring cells. (XLSX)", - "example": true, - "type": "boolean" - }, - "pageOrientation": { - "default": "PORTRAIT", - "description": "Set page orientation. (PDF)", - "enum": [ - "PORTRAIT", - "LANDSCAPE" - ], - "type": "string" - }, - "pageSize": { - "default": "A4", - "description": "Set page size. (PDF)", - "enum": [ - "A3", - "A4", - "LETTER" - ], - "type": "string" + "LabelPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsAssignment" }, - "pdfPageSize": { - "deprecated": true, - "description": "Page size and orientation. (PDF)", - "example": "a4 landscape", - "type": "string" + { + "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" }, - "pdfTableStyle": { - "deprecated": true, - "description": "Custom CSS styles for the table. (PDF, HTML)", - "example": [ - { - "properties": [ - { - "key": "font-size", - "value": "30px" - } - ], - "selector": "th" + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" } - ], - "items": { - "$ref": "#/components/schemas/PdfTableStyle" }, - "type": "array" + "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" }, - "pdfTopLeftContent": { - "deprecated": true, - "description": "Top left header content. (PDF)", - "example": "Good", + { + "properties": { + "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" }, - "pdfTopRightContent": { - "deprecated": true, - "description": "Top right header content. (PDF)", - "example": "Morning", + "key": { "type": "string" - }, - "showFilters": { - "deprecated": true, - "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", - "example": false, - "type": "boolean" } }, + "required": [ + "host", + "key" + ], "type": "object" }, - "SimpleMeasureDefinition": { - "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", - "properties": { - "measure": { + "LiveFeatures": { + "allOf": [ + { + "$ref": "#/components/schemas/Features" + }, + { "properties": { - "aggregation": { - "description": "Definition of aggregation type of the metric.", - "enum": [ - "SUM", - "COUNT", - "AVG", - "MIN", - "MAX", - "MEDIAN", - "RUNSUM", - "APPROXIMATE_COUNT" - ], - "example": "SUM", - "type": "string" - }, - "computeRatio": { - "default": false, - "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", - "example": true, - "type": "boolean" - }, - "filters": { - "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", - "items": { - "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" - }, - "type": "array" - }, - "item": { - "$ref": "#/components/schemas/AfmObjectIdentifierCore" + "configuration": { + "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" } }, - "required": [ - "item" - ], "type": "object" } - }, + ], + "description": "Structure for featureHub", "required": [ - "measure" + "configuration", + "context" ], "type": "object" }, - "Skeleton": { + "LocalIdentifier": { "properties": { - "content": { - "items": { - "type": "object" - }, - "type": "array" + "format": { + "default": "#,##0.00", + "description": "Metric format.", + "example": "#,##0", + "maxLength": 2048, + "nullable": true, + "type": "string" }, - "href": { - "type": "string", - "xml": { - "attribute": true - } + "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" } }, - "type": "object", - "xml": { - "name": "skeleton", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } + "required": [ + "localIdentifier" + ], + "type": "object" }, - "SlidesExportRequest": { - "description": "Export request object describing the export properties and metadata for slides exports.", + "LocaleRequest": { "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "locale": { + "description": "Requested locale in the form of language tag (see RFC 5646).", + "example": "en-US", "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "format": { - "description": "Requested resulting file type.", - "enum": [ - "PDF", - "PPTX" - ], - "example": "PDF", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "templateId": { - "description": "Export template identifier.", - "maxLength": 255, - "nullable": true, - "type": "string" - }, - "timezoneId": { - "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", - "example": "Asia/Kolkata", - "nullable": true, - "type": "string" - }, - "visualizationIds": { - "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true - }, - "widgetIds": { - "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", - "items": { - "maxLength": 255, - "minLength": 1, - "type": "string" - }, - "maxItems": 1, - "type": "array", - "uniqueItems": true } }, "required": [ - "fileName", - "format" + "locale" ], "type": "object" }, - "Smtp": { - "allOf": [ - { + "MatchAttributeFilter": { + "description": "Filter via label with given match type and literal value.", + "properties": { + "matchAttributeFilter": { "properties": { - "fromEmail": { - "default": "no-reply@gooddata.com", - "description": "E-mail address to send notifications from.", - "format": "email", - "type": "string" + "applyOnResult": { + "type": "boolean" }, - "fromEmailName": { - "default": "GoodData", - "description": "An optional e-mail name to send notifications from.", - "type": "string" + "caseSensitive": { + "default": false, + "description": "Indicates whether the filter match is evaluated in case-sensitive mode or not.", + "type": "boolean" }, - "host": { - "description": "The SMTP server address.", - "type": "string" + "label": { + "$ref": "#/components/schemas/AfmIdentifier" }, - "password": { - "description": "The SMTP server password.", - "type": "string", - "writeOnly": true + "literal": { + "description": "Literal used to limit label values.", + "example": "value", + "type": "string" }, - "port": { - "description": "The SMTP server port.", - "enum": [ - 25, - 465, - 587, - 2525 - ], - "format": "int32", - "type": "integer" + "localIdentifier": { + "type": "string" }, - "type": { - "description": "The destination type.", + "matchType": { + "description": "Requested match type.", "enum": [ - "SMTP" + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS" ], "type": "string" }, - "username": { - "description": "The SMTP server username.", - "type": "string" + "negate": { + "default": false, + "description": "Indicates whether the filter should negate the match.", + "type": "boolean" } }, - "type": "object" - } - ], - "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", - "required": [ - "type" - ], - "type": "object" - }, - "SourceReferenceIdentifier": { - "description": "A source reference identifier.", - "properties": { - "id": { - "description": "Source reference ID.", - "example": "fact_id", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" - }, - "type": { - "description": "A type of the reference.", - "enum": [ - "fact", - "attribute" + "required": [ + "label", + "literal", + "matchType" ], - "example": "fact", - "type": "string" + "type": "object" } }, "required": [ - "id", - "type" + "matchAttributeFilter" ], "type": "object" }, - "SqlColumn": { - "description": "Columns defining SQL dataset.", + "MatomoService": { + "description": "Matomo service.", "properties": { - "dataType": { - "description": "Column data type.", - "enum": [ - "INT", - "STRING", - "DATE", - "NUMERIC", - "TIMESTAMP", - "TIMESTAMP_TZ", - "BOOLEAN", - "HLL" - ], - "example": "STRING", + "host": { + "description": "Telemetry host to send events to.", "type": "string" }, - "name": { - "description": "Column name.", - "example": "ABC", + "reportingEndpoint": { + "description": "Optional reporting endpoint for proxying telemetry events.", "type": "string" }, - "nullValue": { - "description": "Value used as sentinel for null values in the column.", - "example": "_", - "type": "string" + "siteId": { + "description": "Site ID on telemetry server.", + "format": "int32", + "type": "integer" } }, "required": [ - "dataType", - "name" + "host", + "siteId" ], "type": "object" }, - "StaticFeatures": { - "allOf": [ + "MeasureDefinition": { + "description": "Abstract metric definition type", + "oneOf": [ { - "$ref": "#/components/schemas/Features" + "$ref": "#/components/schemas/InlineMeasureDefinition" }, { - "properties": { - "items": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - }, - "type": "object" + "$ref": "#/components/schemas/ArithmeticMeasureDefinition" + }, + { + "$ref": "#/components/schemas/SimpleMeasureDefinition" + }, + { + "$ref": "#/components/schemas/PopMeasureDefinition" } ], - "description": "Structure for offline feature flag", - "required": [ - "context", - "items" - ], "type": "object" }, - "StringConstraints": { + "MeasureItem": { + "description": "Metric is a quantity that is calculated from the data.", "properties": { - "allowedValues": { - "items": { - "$ref": "#/components/schemas/StringParameterAllowedValue" - }, - "type": "array", - "uniqueItems": true - }, - "maxLength": { - "format": "int32", - "type": "integer" + "definition": { + "$ref": "#/components/schemas/MeasureDefinition" }, - "minLength": { - "format": "int32", - "type": "integer" + "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" }, - "StringParameterAllowedValue": { - "properties": { - "title": { - "type": "string" + "MeasureValueCondition": { + "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", + "oneOf": [ + { + "$ref": "#/components/schemas/ComparisonCondition" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/RangeCondition" } - }, - "required": [ - "value" ], "type": "object" }, - "StringParameterDefinition": { - "properties": { - "constraints": { - "$ref": "#/components/schemas/StringConstraints" + "MeasureValueFilter": { + "description": "Abstract filter definition type filtering by the value of the metric.", + "oneOf": [ + { + "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, - "defaultValue": { - "type": "string" + { + "$ref": "#/components/schemas/RangeMeasureValueFilter" }, - "type": { - "description": "The parameter type.", - "enum": [ - "STRING" - ], - "type": "string" + { + "$ref": "#/components/schemas/CompoundMeasureValueFilter" } - }, - "required": [ - "defaultValue", - "type" ], "type": "object" }, - "SwitchIdentityProviderRequest": { + "MetricDefinitionOverride": { + "description": "(EXPERIMENTAL) Override for a catalog metric definition.", "properties": { - "idpId": { - "description": "Identity provider ID to set as active for the organization.", - "example": "my-idp-123", - "type": "string" + "definition": { + "$ref": "#/components/schemas/InlineMeasureDefinition" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" } }, "required": [ - "idpId" + "definition", + "item" ], "type": "object" }, - "TableOverride": { - "description": "Table override settings.", + "MetricPermissions": { "properties": { - "columns": { - "description": "An array of column overrides", + "rules": { + "description": "List of rules", "items": { - "$ref": "#/components/schemas/ColumnOverride" + "$ref": "#/components/schemas/RulePermission" }, "type": "array" }, - "path": { - "description": "Path for the table.", - "example": [ - "schema", - "table_name" - ], + "userGroups": { + "description": "List of user groups", "items": { - "type": "string" + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" + }, + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" }, "type": "array" } }, "required": [ - "columns", - "path" + "rules", + "userGroups", + "users" ], "type": "object" }, - "TableStatisticsEntry": { + "MetricPermissionsAssignment": { + "description": "Desired levels of permissions on a metric for an assignee.", "properties": { - "columns": { + "permissions": { "items": { - "$ref": "#/components/schemas/ColumnStatisticsEntry" + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" }, "type": "array" - }, - "dataSize": { - "description": "Total data size of the table in bytes.", - "format": "int64", - "type": "integer" - }, - "rowCount": { - "description": "Total number of rows in the table.", - "format": "int64", - "type": "integer" - }, - "schemaName": { - "type": "string" - }, - "tableName": { - "type": "string" } }, "required": [ - "columns", - "schemaName", - "tableName" + "permissions" ], "type": "object" }, - "TabularExportExecution": { - "description": "A single pre-executed layer in a multi-layer tabular export.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" - }, - "executionResult": { - "description": "Execution result identifier for this layer.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", - "type": "string" + "MetricPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" }, - "title": { - "description": "Layer title used for the exported sheet or file name.", - "example": "Pushpins", - "type": "string" + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" } - }, + ], + "description": "Desired levels of metric permissions for an assignee identified by an identifier.", "required": [ - "executionResult" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "TabularExportRequest": { - "description": "Export request object describing the export properties and overrides for tabular exports.", - "properties": { - "customOverride": { - "$ref": "#/components/schemas/CustomOverride" - }, - "executionResult": { - "description": "Execution result identifier.", - "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", - "type": "string" - }, - "executionSettings": { - "$ref": "#/components/schemas/ExecutionSettings" - }, - "executions": { - "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", - "items": { - "$ref": "#/components/schemas/TabularExportExecution" - }, - "type": "array" - }, - "fileName": { - "description": "Filename of downloaded file without extension.", - "example": "result", - "type": "string" - }, - "format": { - "description": "Expected file format.", - "enum": [ - "CSV", - "XLSX", - "HTML", - "PDF" - ], - "example": "CSV", - "type": "string" - }, - "metadata": { - "$ref": "#/components/schemas/JsonNode" - }, - "relatedDashboardId": { - "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "settings": { - "$ref": "#/components/schemas/Settings" - }, - "visualizationObject": { - "description": "Visualization object identifier. Alternative to executionResult property.", - "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", - "type": "string" - }, - "visualizationObjectCustomFilters": { - "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", - "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", - "items": { - "type": "object" - }, - "type": "array" + "MetricPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsAssignment" }, - "visualizationObjectCustomParameters": { - "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", - "items": { - "$ref": "#/components/schemas/ParameterValue" + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } }, - "type": "array" + "type": "object" } - }, + ], + "description": "Desired levels of metric permissions for a collection of assignees identified by a rule.", "required": [ - "fileName", - "format" + "assigneeRule", + "permissions" ], "type": "object" }, - "TelemetryConfig": { - "description": "Telemetry-related configuration.", + "NegativeAttributeFilter": { + "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { - "context": { - "$ref": "#/components/schemas/TelemetryContext" - }, - "services": { - "$ref": "#/components/schemas/TelemetryServices" + "negativeAttributeFilter": { + "properties": { + "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": [ - "context", - "services" + "negativeAttributeFilter" ], "type": "object" }, - "TelemetryContext": { - "description": "The telemetry context.", + "Note": { "properties": { - "deploymentId": { - "description": "Identification of the deployment.", - "type": "string" - }, - "organizationHash": { - "description": "Organization hash.", - "type": "string" + "appliesTo": { + "enum": [ + "SOURCE", + "TARGET" + ], + "type": "string", + "xml": { + "attribute": true + } }, - "userHash": { - "description": "User hash.", + "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": [ - "deploymentId", - "organizationHash", - "userHash" + "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" }, - "TelemetryServices": { - "description": "Available telemetry services.", + "NumberConstraints": { "properties": { - "amplitude": { - "$ref": "#/components/schemas/AmplitudeService" - }, - "matomo": { - "$ref": "#/components/schemas/MatomoService" + "max": { + "format": "double", + "type": "number" }, - "openTelemetry": { - "$ref": "#/components/schemas/OpenTelemetryService" + "min": { + "format": "double", + "type": "number" } }, "type": "object" }, - "UserAssignee": { - "description": "List of users", + "NumberParameterDefinition": { "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" + "constraints": { + "$ref": "#/components/schemas/NumberConstraints" }, - "id": { - "type": "string" + "defaultValue": { + "format": "double", + "type": "number" }, - "name": { - "description": "User name", - "example": "John Wick", + "type": { + "description": "The parameter type.", + "enum": [ + "NUMBER" + ], "type": "string" } }, "required": [ - "id" + "defaultValue", + "type" ], "type": "object" }, - "UserGroupAssignee": { - "description": "List of user groups", + "ObjectConditionalFormatting": { + "description": "Conditional formatting inherited by every table column that renders this object.", + "nullable": true, "properties": { - "id": { - "type": "string" + "conditions": { + "description": "Conditions evaluated in order; the first match wins.", + "items": { + "$ref": "#/components/schemas/ConditionalFormattingCondition" + }, + "type": "array" }, - "name": { - "description": "User group name", - "example": "admins", + "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", "type": "string" } }, "required": [ - "id" + "self" ], "type": "object" }, - "UserGroupIdentifier": { - "description": "A list of groups where user is a member", + "ObjectLinksContainer": { "properties": { - "id": { + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + }, + "type": "object" + }, + "OpenAIProviderConfig": { + "description": "Configuration for OpenAI provider.", + "properties": { + "auth": { + "$ref": "#/components/schemas/OpenAiProviderAuth" + }, + "baseUrl": { + "default": "https://api.openai.com/v1", + "description": "Custom base URL for OpenAI API.", + "maxLength": 255, "type": "string" }, - "name": { + "organization": { + "description": "OpenAI organization ID.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "type": { + "description": "Provider type.", + "enum": [ + "OPENAI" + ], "type": "string" } }, "required": [ - "id" + "auth", + "type" ], "type": "object" }, - "UserGroupPermission": { - "description": "List of user groups", + "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": { + "host": { + "description": "Telemetry host to send events to.", + "type": "string" + } + }, + "required": [ + "host" + ], + "type": "object" + }, + "OrganizationAutomationIdentifier": { "properties": { "id": { "type": "string" }, - "name": { - "description": "Name of the user group", - "example": "admins", + "workspaceId": { "type": "string" - }, - "permissions": { - "description": "Permissions granted to the user group", + } + }, + "required": [ + "id", + "workspaceId" + ], + "type": "object" + }, + "OrganizationAutomationManagementBulkRequest": { + "properties": { + "automations": { "items": { - "$ref": "#/components/schemas/GrantedPermission" + "$ref": "#/components/schemas/OrganizationAutomationIdentifier" }, "type": "array" } }, "required": [ - "id" + "automations" ], "type": "object" }, - "UserManagementDataSourcePermissionAssignment": { - "description": "Datasource permission assignments for users and userGroups", + "OrganizationPermissionAssignment": { + "description": "Organization permission assignments", "properties": { - "accessSource": { - "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", - "enum": [ - "DIRECT", - "GROUP" - ], - "readOnly": true, - "type": "string" - }, - "id": { - "description": "Id of the datasource", - "type": "string" - }, - "name": { - "description": "Name of the datasource", - "readOnly": true, - "type": "string" + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" }, "permissions": { "items": { "enum": [ "MANAGE", - "USE" + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" ], "type": "string" }, @@ -30622,931 +35302,4358 @@ } }, "required": [ - "id", + "assigneeIdentifier", "permissions" ], "type": "object" }, - "UserManagementPermissionAssignments": { + "Over": { "properties": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" - }, - "type": "array" - }, - "workspaces": { + "attributes": { "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + "$ref": "#/components/schemas/IdentifierRef" }, "type": "array" } }, "required": [ - "dataSources", - "workspaces" + "attributes" ], "type": "object" }, - "UserManagementUserGroupMember": { + "PageMetadata": { "properties": { - "id": { - "type": "string" + "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": { - "readOnly": true, + "type": "string" + }, + "value": { "type": "string" } }, "required": [ - "id" + "name", + "value" ], "type": "object" }, - "UserManagementUserGroupMembers": { - "properties": { - "members": { - "items": { - "$ref": "#/components/schemas/UserManagementUserGroupMember" - }, - "type": "array" - } + "ParameterDefinition": { + "description": "Parameter content (type-discriminated).", + "discriminator": { + "mapping": { + "NUMBER": "#/components/schemas/NumberParameterDefinition", + "STRING": "#/components/schemas/StringParameterDefinition" + }, + "propertyName": "type" }, - "required": [ - "members" + "oneOf": [ + { + "$ref": "#/components/schemas/NumberParameterDefinition" + }, + { + "$ref": "#/components/schemas/StringParameterDefinition" + } ], "type": "object" }, - "UserManagementUserGroups": { + "ParameterItem": { + "additionalProperties": true, + "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { - "totalCount": { - "description": "Total number of groups", - "format": "int32", - "type": "integer" + "parameter": { + "$ref": "#/components/schemas/AfmObjectIdentifierParameter" }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/UserManagementUserGroupsItem" - }, - "type": "array" + "value": { + "description": "Value to use for this parameter instead of its default.", + "type": "string" } }, "required": [ - "totalCount", - "userGroups" + "parameter", + "value" ], "type": "object" }, - "UserManagementUserGroupsItem": { - "description": "List of groups", + "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": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" - }, - "type": "array" - }, "id": { + "description": "Identifier of the workspace parameter (matches the parameter entity id).", + "example": "year", "type": "string" }, - "name": { - "description": "Group name", - "example": "admins", + "title": { + "description": "Display title of the parameter as the client wants it rendered on the info sheet.", + "example": "Year", "type": "string" }, - "organizationAdmin": { - "description": "Is group organization admin", - "example": false, - "type": "boolean" - }, - "userCount": { - "description": "The number of users belonging to the group", - "format": "int32", - "type": "integer" + "value": { + "description": "Value to use for this parameter when executing the export.", + "example": "2026", + "type": "string" }, - "workspaces": { - "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" - }, - "type": "array" + "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": [ - "dataSources", "id", - "organizationAdmin", - "userCount", - "workspaces" + "title", + "value" ], "type": "object" }, - "UserManagementUsers": { + "PdfTableStyle": { + "deprecated": true, + "description": "Custom CSS styles for the table. (PDF, HTML)", + "example": [ + { + "properties": [ + { + "key": "font-size", + "value": "30px" + } + ], + "selector": "th" + } + ], "properties": { - "totalCount": { - "description": "The total number of users is based on applied filters.", - "format": "int32", - "type": "integer" - }, - "users": { + "properties": { + "description": "List of CSS properties.", "items": { - "$ref": "#/components/schemas/UserManagementUsersItem" + "$ref": "#/components/schemas/PdfTableStyleProperty" }, "type": "array" + }, + "selector": { + "description": "CSS selector where to apply given properties.", + "type": "string" } }, "required": [ - "totalCount", - "users" + "selector" ], "type": "object" }, - "UserManagementUsersItem": { - "description": "List of users", + "PdfTableStyleProperty": { + "description": "CSS property.", "properties": { - "dataSources": { - "items": { - "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" - }, - "type": "array" - }, - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { + "key": { + "description": "CSS property key.", "type": "string" }, - "name": { - "description": "User name", - "example": "John Wick", + "value": { + "description": "CSS property value.", "type": "string" - }, - "organizationAdmin": { - "description": "Is user organization admin", - "example": false, - "type": "boolean" - }, - "systemAccount": { - "description": "Is user system account", - "example": false, - "type": "boolean" - }, - "userGroups": { + } + }, + "required": [ + "key", + "value" + ], + "type": "object" + }, + "PdmLdmRequest": { + "description": "PDM additions wrapper.", + "properties": { + "sqls": { + "description": "List of SQL datasets.", "items": { - "$ref": "#/components/schemas/UserGroupIdentifier" + "$ref": "#/components/schemas/PdmSql" }, "type": "array" }, - "workspaces": { + "tableOverrides": { + "description": "(BETA) List of table overrides.", "items": { - "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + "$ref": "#/components/schemas/TableOverride" + }, + "type": "array" + }, + "tables": { + "description": "List of physical database tables.", + "items": { + "$ref": "#/components/schemas/DeclarativeTable" }, "type": "array" } }, - "required": [ - "dataSources", - "id", - "organizationAdmin", - "systemAccount", - "userGroups", - "workspaces" - ], "type": "object" }, - "UserManagementWorkspacePermissionAssignment": { - "description": "Workspace permission assignments for users and userGroups", + "PdmSql": { + "description": "SQL dataset definition.", "properties": { - "accessSource": { - "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", - "enum": [ - "DIRECT", - "GROUP", - "HIERARCHY" - ], - "readOnly": true, - "type": "string" - }, - "hierarchyPermissions": { + "columns": { + "description": "Columns defining SQL dataset.", "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" + "$ref": "#/components/schemas/SqlColumn" }, "type": "array" }, - "id": { + "statement": { + "description": "SQL statement.", + "example": "select * from abc", "type": "string" }, - "name": { - "readOnly": true, + "title": { + "description": "SQL dataset title.", + "example": "My special dataset", "type": "string" - }, - "permissions": { - "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" - }, - "type": "array" } }, "required": [ - "hierarchyPermissions", - "id", - "permissions" + "statement", + "title" ], "type": "object" }, - "UserPermission": { - "description": "List of users", + "PermissionsAssignment": { "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", - "type": "string" - }, - "id": { - "type": "string" + "assignees": { + "items": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "minItems": 1, + "type": "array" }, - "name": { - "description": "Name of user", - "example": "John Wick", - "type": "string" + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" }, - "permissions": { - "description": "Permissions granted to the user", + "workspaces": { "items": { - "$ref": "#/components/schemas/GrantedPermission" + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, "type": "array" } }, "required": [ - "id" + "assignees" ], "type": "object" }, - "ValidityPeriodCacheRetention": { - "description": "The cache expires once a fixed period elapses since the results were computed.", - "properties": { - "type": { - "description": "The cache retention type.", - "enum": [ - "VALIDITY_PERIOD" - ], - "type": "string" + "PermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, - "validityPeriod": { - "description": "How long the cached results stay valid after they were computed.", - "example": "P1D", - "format": "duration", - "type": "string" + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" } - }, + ], + "description": "Desired levels of permissions for an assignee identified by an identifier.", "required": [ - "type", - "validityPeriod" + "assigneeIdentifier", + "permissions" ], "type": "object" }, - "Value": { - "properties": { - "value": { - "description": "Value of the alert threshold to compare the metric to.", - "example": 1000, - "type": "number" + "PermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/DashboardPermissionsAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" } - }, + ], + "description": "Desired levels of permissions for a collection of assignees identified by a rule.", "required": [ - "value" + "assigneeRule", + "permissions" ], "type": "object" }, - "VisibleFilter": { + "PlatformUsage": { "properties": { - "isAllTimeDateFilter": { - "default": false, - "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", - "type": "boolean" - }, - "localIdentifier": { - "type": "string" + "count": { + "format": "int32", + "type": "integer" }, - "title": { + "name": { + "enum": [ + "UserCount", + "WorkspaceCount", + "AiWorkspaceCount" + ], "type": "string" } }, + "required": [ + "name" + ], "type": "object" }, - "VisualExportRequest": { - "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", + "PlatformUsageRequest": { "properties": { - "dashboardId": { - "description": "Dashboard identifier", - "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", - "type": "string" - }, - "fileName": { - "description": "File name to be used for retrieving the pdf document.", - "example": "filename", - "type": "string" - }, - "metadata": { - "description": "Metadata definition in free-form JSON format.", - "example": "{}", - "type": "object" + "usageItemNames": { + "items": { + "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" }, - "timezoneId": { - "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", - "example": "Asia/Kolkata", - "nullable": true, - "type": "string" + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" } }, "required": [ - "dashboardId", - "fileName" + "dataset", + "periodsAgo" ], "type": "object" }, - "Webhook": { - "allOf": [ - { + "PopDatasetMeasureDefinition": { + "description": "Previous period type of metric.", + "properties": { + "previousPeriodMeasure": { "properties": { - "hasSecretKey": { - "description": "Flag indicating if webhook has a hmac secret key.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "hasToken": { - "description": "Flag indicating if webhook has a token.", - "maxLength": 10000, - "nullable": true, - "readOnly": true, - "type": "boolean" - }, - "secretKey": { - "description": "Hmac secret key for the webhook signature.", - "example": "secret_key", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "token": { - "description": "Bearer token for the webhook.", - "example": "secret", - "maxLength": 10000, - "nullable": true, - "type": "string", - "writeOnly": true - }, - "type": { - "description": "The destination type.", - "enum": [ - "WEBHOOK" - ], - "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" + }, + "type": "array" }, - "url": { - "description": "The webhook URL.", - "example": "https://webhook.site/something", - "maxLength": 255, - "pattern": "https?\\://.*", - "type": "string" + "measureIdentifier": { + "$ref": "#/components/schemas/AfmLocalIdentifier" } }, + "required": [ + "dateDatasets", + "measureIdentifier" + ], "type": "object" } - ], - "description": "Webhook destination for notifications. The property url is required on create and update.", + }, "required": [ - "type" + "previousPeriodMeasure" ], "type": "object" }, - "WidgetSlidesTemplate": { - "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, + "PopDate": { + "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" - }, - "minItems": 1, - "type": "array" + "attribute": { + "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" + "periodsAgo": { + "description": "Number of periods ago to calculate the previous period for.", + "example": 1, + "format": "int32", + "type": "integer" } }, "required": [ - "appliedOn" + "attribute", + "periodsAgo" ], "type": "object" }, - "WorkspaceAutomationIdentifier": { + "PopDateMeasureDefinition": { + "description": "Period over period type of metric.", "properties": { - "id": { - "type": "string" + "overPeriodMeasure": { + "properties": { + "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": [ - "id" + "overPeriodMeasure" ], "type": "object" }, - "WorkspaceAutomationManagementBulkRequest": { + "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": { - "automations": { - "items": { - "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" + "positiveAttributeFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "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" + } }, - "type": "array" + "required": [ + "in", + "label" + ], + "type": "object" } }, "required": [ - "automations" + "positiveAttributeFilter" ], "type": "object" }, - "WorkspaceDashboardSlidesTemplate": { - "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, + "Profile": { "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], + "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": [ - "PDF", - "PPTX" + "MANAGE", + "SELF_CREATE_TOKEN", + "BASE_UI_ACCESS" ], "type": "string" }, - "minItems": 1, "type": "array" }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - }, - "coverSlide": { - "$ref": "#/components/schemas/CoverSlideTemplate" - }, - "introSlide": { - "$ref": "#/components/schemas/IntroSlideTemplate" + "telemetryConfig": { + "$ref": "#/components/schemas/TelemetryConfig" }, - "sectionSlide": { - "$ref": "#/components/schemas/SectionSlideTemplate" + "userId": { + "type": "string" } }, "required": [ - "appliedOn" + "entitlements", + "features", + "links", + "organizationId", + "organizationName", + "permissions", + "telemetryConfig", + "userId" ], "type": "object" }, - "WorkspaceDataSource": { - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "ProfileLinks": { "properties": { - "id": { - "description": "The ID of the used data source.", - "example": "snowflake.instance.1", + "organization": { "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" + "self": { + "type": "string" + }, + "user": { + "type": "string" } }, "required": [ - "id" + "organization", + "self", + "user" ], "type": "object" }, - "WorkspaceIdentifier": { - "description": "A workspace identifier.", - "example": "{ id: demo, type: workspace }", + "Range": { "properties": { - "id": { - "description": "Identifier of the workspace.", - "example": "alpha.sales", - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string" + "from": { + "$ref": "#/components/schemas/Value" }, - "type": { - "description": "A type.", + "measure": { + "$ref": "#/components/schemas/LocalIdentifier" + }, + "operator": { "enum": [ - "workspace" + "BETWEEN", + "NOT_BETWEEN" ], - "example": "workspace", "type": "string" + }, + "to": { + "$ref": "#/components/schemas/Value" } }, "required": [ - "id", - "type" + "from", + "measure", + "operator", + "to" ], "type": "object" }, - "WorkspacePermissionAssignment": { - "description": "Workspace permission assignments", + "RangeCondition": { + "description": "Condition that checks if the metric value is within a given range.", "properties": { - "assigneeIdentifier": { - "$ref": "#/components/schemas/AssigneeIdentifier" - }, - "hierarchyPermissions": { - "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" + "range": { + "properties": { + "from": { + "example": 100, + "type": "number" + }, + "operator": { + "enum": [ + "BETWEEN", + "NOT_BETWEEN" + ], + "example": "BETWEEN", + "type": "string" + }, + "to": { + "example": 999, + "type": "number" + } }, - "type": "array" - }, - "permissions": { - "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", - "CREATE_VISUALIZATION", - "CREATE_COMPUTED_ATTRIBUTE", - "VIEW" - ], - "type": "string" + "required": [ + "from", + "operator", + "to" + ], + "type": "object" + } + }, + "required": [ + "range" + ], + "type": "object" + }, + "RangeMeasureValueFilter": { + "description": "Filter the result by comparing specified metric to given range of values.", + "properties": { + "rangeMeasureValueFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dimensionality": { + "description": "References to the attributes to be used when filtering.", + "items": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "type": "array" + }, + "from": { + "example": 100, + "type": "number" + }, + "localIdentifier": { + "type": "string" + }, + "measure": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "operator": { + "enum": [ + "BETWEEN", + "NOT_BETWEEN" + ], + "example": "BETWEEN", + "type": "string" + }, + "to": { + "example": 999, + "type": "number" + }, + "treatNullValuesAs": { + "description": "A value that will be substituted for null values in the metric for the comparisons.", + "example": 0, + "type": "number" + } }, - "type": "array" + "required": [ + "from", + "measure", + "operator", + "to" + ], + "type": "object" } }, "required": [ - "assigneeIdentifier" + "rangeMeasureValueFilter" ], "type": "object" }, - "WorkspaceUser": { - "description": "List of workspace users", + "RangeWrapper": { "properties": { - "email": { - "description": "User email address", - "example": "user@example.com", + "range": { + "$ref": "#/components/schemas/Range" + } + }, + "required": [ + "range" + ], + "type": "object" + }, + "RankingFilter": { + "description": "Filter the result on top/bottom N values according to given metric(s).", + "properties": { + "rankingFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "dimensionality": { + "description": "References to the attributes to be used when filtering.", + "items": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "type": "array" + }, + "localIdentifier": { + "type": "string" + }, + "measures": { + "description": "References to the metrics to be used when filtering.", + "items": { + "$ref": "#/components/schemas/AfmIdentifier" + }, + "type": "array" + }, + "operator": { + "description": "The type of ranking to use, TOP or BOTTOM.", + "enum": [ + "TOP", + "BOTTOM" + ], + "type": "string" + }, + "strictLimitOfRows": { + "description": "When true, filter returns requested number of rows at most. Default is false.", + "type": "boolean" + }, + "value": { + "description": "Number of top/bottom values to filter.", + "example": 5, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "measures", + "operator", + "value" + ], + "type": "object" + } + }, + "required": [ + "rankingFilter" + ], + "type": "object" + }, + "RawCustomLabel": { + "description": "Custom label object override.", + "properties": { + "title": { + "description": "Override value.", + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "RawCustomMetric": { + "description": "Custom metric object override.", + "properties": { + "title": { + "description": "Metric title override.", + "type": "string" + } + }, + "required": [ + "title" + ], + "type": "object" + }, + "RawCustomOverride": { + "description": "Custom cell value overrides (IDs will be replaced with specified values).", + "properties": { + "labels": { + "additionalProperties": { + "$ref": "#/components/schemas/RawCustomLabel" + }, + "description": "Map of CustomLabels with keys used as placeholders in export result.", + "type": "object" + }, + "metrics": { + "additionalProperties": { + "$ref": "#/components/schemas/RawCustomMetric" + }, + "description": "Map of CustomMetrics with keys used as placeholders in export result.", + "type": "object" + } + }, + "type": "object" + }, + "RawExportAutomationRequest": { + "description": "Export request object describing the export properties and overrides for raw exports.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/RawCustomOverride" + }, + "delimiter": { + "description": "Set column delimiter. (CSV)", + "maxLength": 1, + "minLength": 1, + "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", "type": "string" }, - "id": { + "execution": { + "$ref": "#/components/schemas/AFM" + }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "fileName": { + "description": "Filename of downloaded file without extension.", + "example": "result", "type": "string" }, - "name": { - "description": "User name", - "example": "John Wick", + "format": { + "description": "Requested resulting file type.", + "enum": [ + "ARROW_FILE", + "ARROW_STREAM", + "CSV" + ], + "example": "CSV", "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/JsonNode" } }, "required": [ - "id" + "execution", + "fileName", + "format" ], "type": "object" }, - "WorkspaceUserGroup": { - "description": "List of workspace groups", + "ReferenceIdentifier": { + "description": "A reference identifier.", "properties": { "id": { + "description": "Reference ID.", + "example": "customers", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, - "name": { - "description": "Group name", - "example": "admins", + "type": { + "description": "A type of the reference.", + "enum": [ + "dataset" + ], + "example": "DATASET", "type": "string" } }, "required": [ - "id" + "id", + "type" ], "type": "object" }, - "WorkspaceUserGroups": { + "ReferenceSourceColumn": { "properties": { - "totalCount": { - "description": "Total number of groups", - "format": "int32", - "type": "integer" + "column": { + "type": "string" }, - "userGroups": { - "items": { - "$ref": "#/components/schemas/WorkspaceUserGroup" - }, - "type": "array" + "dataType": { + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "type": "string" + }, + "isNullable": { + "type": "boolean" + }, + "nullValue": { + "type": "string" + }, + "target": { + "$ref": "#/components/schemas/DatasetGrain" } }, "required": [ - "totalCount", - "userGroups" + "target" ], "type": "object" }, - "WorkspaceUsers": { + "Relative": { "properties": { - "totalCount": { - "description": "The total number of users is based on applied filters.", + "measure": { + "$ref": "#/components/schemas/ArithmeticMeasure" + }, + "operator": { + "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", + "enum": [ + "INCREASES_BY", + "DECREASES_BY", + "CHANGES_BY" + ], + "type": "string" + }, + "threshold": { + "$ref": "#/components/schemas/Value" + } + }, + "required": [ + "measure", + "operator", + "threshold" + ], + "type": "object" + }, + "RelativeBoundedDateFilter": { + "properties": { + "from": { "format": "int32", "type": "integer" }, - "users": { - "items": { - "$ref": "#/components/schemas/WorkspaceUser" - }, - "type": "array" + "granularity": { + "enum": [ + "ALL_TIME_GRANULARITY", + "GDC.time.year", + "GDC.time.week_us", + "GDC.time.week_in_year", + "GDC.time.week_in_quarter", + "GDC.time.week", + "GDC.time.euweek_in_year", + "GDC.time.euweek_in_quarter", + "GDC.time.quarter", + "GDC.time.quarter_in_year", + "GDC.time.month", + "GDC.time.month_in_quarter", + "GDC.time.month_in_year", + "GDC.time.day_in_year", + "GDC.time.day_in_quarter", + "GDC.time.day_in_month", + "GDC.time.day_in_week", + "GDC.time.day_in_euweek", + "GDC.time.date", + "GDC.time.hour", + "GDC.time.hour_in_day", + "GDC.time.minute", + "GDC.time.minute_in_hour", + "GDC.time.minute_in_day", + "GDC.time.second", + "GDC.time.second_in_minute", + "GDC.time.second_in_day", + "GDC.time.fiscal_week", + "GDC.time.fiscal_month", + "GDC.time.fiscal_quarter", + "GDC.time.fiscal_semester", + "GDC.time.fiscal_year", + "GDC.time.fiscal_day_in_fiscal_week", + "GDC.time.fiscal_day_in_fiscal_month", + "GDC.time.fiscal_day_in_fiscal_quarter", + "GDC.time.fiscal_day_in_fiscal_semester", + "GDC.time.fiscal_day_in_fiscal_year", + "GDC.time.fiscal_week_in_fiscal_month", + "GDC.time.fiscal_week_in_fiscal_quarter", + "GDC.time.fiscal_week_in_fiscal_semester", + "GDC.time.fiscal_week_in_fiscal_year", + "GDC.time.fiscal_month_in_fiscal_quarter", + "GDC.time.fiscal_month_in_fiscal_semester", + "GDC.time.fiscal_month_in_fiscal_year", + "GDC.time.fiscal_quarter_in_fiscal_semester", + "GDC.time.fiscal_quarter_in_fiscal_year", + "GDC.time.fiscal_semester_in_fiscal_year" + ], + "type": "string" + }, + "to": { + "format": "int32", + "type": "integer" } }, "required": [ - "totalCount", - "users" + "granularity" ], "type": "object" }, - "WorkspaceWidgetSlidesTemplate": { - "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", - "nullable": true, + "RelativeDateFilter": { + "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", "properties": { - "appliedOn": { - "description": "Export types this template applies to.", - "example": [ - "PDF", - "PPTX" - ], - "items": { - "enum": [ - "PDF", - "PPTX" - ], - "type": "string" + "relativeDateFilter": { + "properties": { + "applyOnResult": { + "type": "boolean" + }, + "boundedFilter": { + "$ref": "#/components/schemas/BoundedFilter" + }, + "dataset": { + "$ref": "#/components/schemas/AfmObjectIdentifierDataset" + }, + "emptyValueHandling": { + "default": "EXCLUDE", + "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", + "enum": [ + "INCLUDE", + "EXCLUDE", + "ONLY" + ], + "type": "string" + }, + "from": { + "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", + "example": -6, + "format": "int32", + "type": "integer" + }, + "granularity": { + "description": "Date granularity specifying particular date attribute in given dimension.", + "enum": [ + "SECOND", + "SECOND_OF_MINUTE", + "SECOND_OF_DAY", + "MINUTE", + "MINUTE_OF_HOUR", + "MINUTE_OF_DAY", + "HOUR", + "HOUR_OF_DAY", + "DAY", + "DAY_OF_WEEK", + "DAY_OF_MONTH", + "DAY_OF_QUARTER", + "DAY_OF_YEAR", + "WEEK", + "WEEK_OF_YEAR", + "MONTH", + "MONTH_OF_YEAR", + "QUARTER", + "QUARTER_OF_YEAR", + "YEAR", + "FISCAL_DAY_OF_FISCAL_WEEK", + "FISCAL_DAY_OF_FISCAL_MONTH", + "FISCAL_DAY_OF_FISCAL_QUARTER", + "FISCAL_DAY_OF_FISCAL_SEMESTER", + "FISCAL_DAY_OF_FISCAL_YEAR", + "FISCAL_WEEK", + "FISCAL_WEEK_OF_FISCAL_MONTH", + "FISCAL_WEEK_OF_FISCAL_QUARTER", + "FISCAL_WEEK_OF_FISCAL_SEMESTER", + "FISCAL_WEEK_OF_FISCAL_YEAR", + "FISCAL_MONTH", + "FISCAL_MONTH_OF_FISCAL_QUARTER", + "FISCAL_MONTH_OF_FISCAL_SEMESTER", + "FISCAL_MONTH_OF_FISCAL_YEAR", + "FISCAL_QUARTER", + "FISCAL_QUARTER_OF_FISCAL_SEMESTER", + "FISCAL_QUARTER_OF_FISCAL_YEAR", + "FISCAL_SEMESTER", + "FISCAL_SEMESTER_OF_FISCAL_YEAR", + "FISCAL_YEAR" + ], + "example": "DAY", + "type": "string" + }, + "localIdentifier": { + "type": "string" + }, + "to": { + "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", + "example": 0, + "format": "int32", + "type": "integer" + } + }, + "required": [ + "dataset", + "from", + "granularity", + "to" + ], + "type": "object" + } + }, + "required": [ + "relativeDateFilter" + ], + "type": "object" + }, + "RelativeWrapper": { + "properties": { + "relative": { + "$ref": "#/components/schemas/Relative" + } + }, + "required": [ + "relative" + ], + "type": "object" + }, + "ResolveSettingsRequest": { + "description": "A request containing setting IDs to resolve.", + "properties": { + "settings": { + "description": "An array of setting IDs to resolve.", + "example": [ + "timezone" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "ResolvedSetting": { + "description": "Setting and its value.", + "properties": { + "content": { + "$ref": "#/components/schemas/JsonNode" + }, + "id": { + "deprecated": true, + "description": "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", + "type": "string" + }, + "type": { + "description": "Type of the setting.", + "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", + "AUTHORIZATION_SERVER_REDIRECT_POLICY", + "DEFAULT_VISUALIZATION_VISIBILITY", + "DEFAULT_METRIC_VISIBILITY", + "GRANT_MANAGE_VISUALIZATIONS_WITH_ANALYZE" + ], + "example": "TIMEZONE", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "RestrictedObject": { + "description": "A reference the caller may not view.", + "properties": { + "id": { + "description": "Object identifier, unique within one workspace hierarchy.", + "type": "string" + }, + "type": { + "description": "JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.", + "enum": [ + "analyticalDashboard", + "attribute", + "attributeHierarchy", + "computedAttribute", + "fact", + "label", + "metric", + "userDataFilter", + "visualizationObject" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "RsaSpecification": { + "properties": { + "alg": { + "enum": [ + "RS256", + "RS384", + "RS512" + ], + "type": "string" + }, + "e": { + "type": "string" + }, + "kid": { + "maxLength": 255, + "minLength": 0, + "pattern": "^[^.]", + "type": "string" + }, + "kty": { + "enum": [ + "RSA" + ], + "type": "string" + }, + "n": { + "type": "string" + }, + "use": { + "enum": [ + "sig" + ], + "type": "string" + }, + "x5c": { + "items": { + "type": "string" + }, + "type": "array" + }, + "x5t": { + "type": "string" + } + }, + "required": [ + "alg", + "e", + "kid", + "kty", + "n", + "use" + ], + "type": "object" + }, + "RulePermission": { + "description": "List of rules", + "properties": { + "permissions": { + "description": "Permissions granted by the rule", + "items": { + "$ref": "#/components/schemas/GrantedPermission" + }, + "type": "array" + }, + "type": { + "description": "Type of the rule", + "example": "allWorkspaceUsers", + "type": "string" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + "RunningSection": { + "description": "Footer section of the slide", + "nullable": true, + "properties": { + "left": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" + }, + "right": { + "description": "Either {{logo}} variable or custom text with combination of other variables.", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "ScheduleCacheRetention": { + "description": "The cache expires according to a schedule.", + "properties": { + "schedule": { + "$ref": "#/components/schemas/CacheRetentionSchedule" + }, + "type": { + "description": "The cache retention type.", + "enum": [ + "SCHEDULE" + ], + "type": "string" + } + }, + "required": [ + "schedule", + "type" + ], + "type": "object" + }, + "SectionSlideTemplate": { + "description": "Settings for section slide.", + "nullable": true, + "properties": { + "backgroundImage": { + "default": true, + "description": "Show background image on the slide.", + "type": "boolean" + }, + "footer": { + "$ref": "#/components/schemas/RunningSection" + }, + "header": { + "$ref": "#/components/schemas/RunningSection" + } + }, + "type": "object" + }, + "SetCertificationRequest": { + "description": "Request to set or clear the certification of a workspace entity.", + "properties": { + "id": { + "description": "ID of the entity.", + "example": "total-sales", + "type": "string" + }, + "message": { + "description": "Optional message associated with the certification.", + "nullable": true, + "type": "string" + }, + "status": { + "description": "Certification status of the entity.", + "enum": [ + "CERTIFIED" + ], + "nullable": true, + "type": "string" + }, + "type": { + "description": "Type of the entity.", + "enum": [ + "metric", + "visualizationObject", + "analyticalDashboard", + "computedAttribute" + ], + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "Settings": { + "description": "Additional settings.", + "properties": { + "delimiter": { + "description": "Set column delimiter. (CSV)", + "maxLength": 1, + "minLength": 1, + "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", + "type": "string" + }, + "exportInfo": { + "default": false, + "description": "If true, the export will contain the information about the export – exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", + "example": true, + "type": "boolean" + }, + "grandTotalsPosition": { + "description": "Grand totals position. Takes precedence over position specified in visualization.", + "enum": [ + "pinnedBottom", + "pinnedTop", + "bottom", + "top" + ], + "type": "string" + }, + "mergeHeaders": { + "description": "Merge equal headers in neighbouring cells. (XLSX)", + "example": true, + "type": "boolean" + }, + "pageOrientation": { + "default": "PORTRAIT", + "description": "Set page orientation. (PDF)", + "enum": [ + "PORTRAIT", + "LANDSCAPE" + ], + "type": "string" + }, + "pageSize": { + "default": "A4", + "description": "Set page size. (PDF)", + "enum": [ + "A3", + "A4", + "LETTER" + ], + "type": "string" + }, + "pdfPageSize": { + "deprecated": true, + "description": "Page size and orientation. (PDF)", + "example": "a4 landscape", + "type": "string" + }, + "pdfTableStyle": { + "deprecated": true, + "description": "Custom CSS styles for the table. (PDF, HTML)", + "example": [ + { + "properties": [ + { + "key": "font-size", + "value": "30px" + } + ], + "selector": "th" + } + ], + "items": { + "$ref": "#/components/schemas/PdfTableStyle" + }, + "type": "array" + }, + "pdfTopLeftContent": { + "deprecated": true, + "description": "Top left header content. (PDF)", + "example": "Good", + "type": "string" + }, + "pdfTopRightContent": { + "deprecated": true, + "description": "Top right header content. (PDF)", + "example": "Morning", + "type": "string" + }, + "showFilters": { + "deprecated": true, + "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "SimpleMeasureDefinition": { + "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", + "properties": { + "measure": { + "properties": { + "aggregation": { + "description": "Definition of aggregation type of the metric.", + "enum": [ + "SUM", + "COUNT", + "AVG", + "MIN", + "MAX", + "MEDIAN", + "RUNSUM", + "APPROXIMATE_COUNT" + ], + "example": "SUM", + "type": "string" + }, + "computeRatio": { + "default": false, + "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", + "example": true, + "type": "boolean" + }, + "filters": { + "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", + "items": { + "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" + }, + "type": "array" + }, + "item": { + "$ref": "#/components/schemas/AfmObjectIdentifierCore" + } + }, + "required": [ + "item" + ], + "type": "object" + } + }, + "required": [ + "measure" + ], + "type": "object" + }, + "Skeleton": { + "properties": { + "content": { + "items": { + "type": "object" + }, + "type": "array" + }, + "href": { + "type": "string", + "xml": { + "attribute": true + } + } + }, + "type": "object", + "xml": { + "name": "skeleton", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } + }, + "SlidesExportRequest": { + "description": "Export request object describing the export properties and metadata for slides exports.", + "properties": { + "dashboardId": { + "description": "Dashboard identifier", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "fileName": { + "description": "File name to be used for retrieving the pdf document.", + "example": "filename", + "type": "string" + }, + "format": { + "description": "Requested resulting file type.", + "enum": [ + "PDF", + "PPTX" + ], + "example": "PDF", + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/JsonNode" + }, + "templateId": { + "description": "Export template identifier.", + "maxLength": 255, + "nullable": true, + "type": "string" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + }, + "visualizationIds": { + "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + }, + "widgetIds": { + "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", + "items": { + "maxLength": 255, + "minLength": 1, + "type": "string" + }, + "maxItems": 1, + "type": "array", + "uniqueItems": true + } + }, + "required": [ + "fileName", + "format" + ], + "type": "object" + }, + "Smtp": { + "allOf": [ + { + "properties": { + "fromEmail": { + "default": "no-reply@gooddata.com", + "description": "E-mail address to send notifications from.", + "format": "email", + "type": "string" + }, + "fromEmailName": { + "default": "GoodData", + "description": "An optional e-mail name to send notifications from.", + "type": "string" + }, + "host": { + "description": "The SMTP server address.", + "type": "string" + }, + "password": { + "description": "The SMTP server password.", + "type": "string", + "writeOnly": true + }, + "port": { + "description": "The SMTP server port.", + "enum": [ + 25, + 465, + 587, + 2525 + ], + "format": "int32", + "type": "integer" + }, + "type": { + "description": "The destination type.", + "enum": [ + "SMTP" + ], + "type": "string" + }, + "username": { + "description": "The SMTP server username.", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", + "required": [ + "type" + ], + "type": "object" + }, + "SourceReferenceIdentifier": { + "description": "A source reference identifier.", + "properties": { + "id": { + "description": "Source reference ID.", + "example": "fact_id", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "A type of the reference.", + "enum": [ + "fact", + "attribute" + ], + "example": "fact", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "SqlColumn": { + "description": "Columns defining SQL dataset.", + "properties": { + "dataType": { + "description": "Column data type.", + "enum": [ + "INT", + "STRING", + "DATE", + "NUMERIC", + "TIMESTAMP", + "TIMESTAMP_TZ", + "BOOLEAN", + "HLL" + ], + "example": "STRING", + "type": "string" + }, + "name": { + "description": "Column name.", + "example": "ABC", + "type": "string" + }, + "nullValue": { + "description": "Value used as sentinel for null values in the column.", + "example": "_", + "type": "string" + } + }, + "required": [ + "dataType", + "name" + ], + "type": "object" + }, + "StaticFeatures": { + "allOf": [ + { + "$ref": "#/components/schemas/Features" + }, + { + "properties": { + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + } + ], + "description": "Structure for offline feature flag", + "required": [ + "context", + "items" + ], + "type": "object" + }, + "StringConstraints": { + "properties": { + "allowedValues": { + "items": { + "$ref": "#/components/schemas/StringParameterAllowedValue" + }, + "type": "array", + "uniqueItems": true + }, + "maxLength": { + "format": "int32", + "type": "integer" + }, + "minLength": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "StringParameterAllowedValue": { + "properties": { + "title": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "StringParameterDefinition": { + "properties": { + "constraints": { + "$ref": "#/components/schemas/StringConstraints" + }, + "defaultValue": { + "type": "string" + }, + "type": { + "description": "The parameter type.", + "enum": [ + "STRING" + ], + "type": "string" + } + }, + "required": [ + "defaultValue", + "type" + ], + "type": "object" + }, + "SwitchIdentityProviderRequest": { + "properties": { + "idpId": { + "description": "Identity provider ID to set as active for the organization.", + "example": "my-idp-123", + "type": "string" + } + }, + "required": [ + "idpId" + ], + "type": "object" + }, + "TableOverride": { + "description": "Table override settings.", + "properties": { + "columns": { + "description": "An array of column overrides", + "items": { + "$ref": "#/components/schemas/ColumnOverride" + }, + "type": "array" + }, + "path": { + "description": "Path for the table.", + "example": [ + "schema", + "table_name" + ], + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "columns", + "path" + ], + "type": "object" + }, + "TableStatisticsEntry": { + "properties": { + "columns": { + "items": { + "$ref": "#/components/schemas/ColumnStatisticsEntry" + }, + "type": "array" + }, + "dataSize": { + "description": "Total data size of the table in bytes.", + "format": "int64", + "type": "integer" + }, + "rowCount": { + "description": "Total number of rows in the table.", + "format": "int64", + "type": "integer" + }, + "schemaName": { + "type": "string" + }, + "tableName": { + "type": "string" + } + }, + "required": [ + "columns", + "schemaName", + "tableName" + ], + "type": "object" + }, + "TabularExportExecution": { + "description": "A single pre-executed layer in a multi-layer tabular export.", + "properties": { + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier for this layer.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type": "string" + }, + "title": { + "description": "Layer title used for the exported sheet or file name.", + "example": "Pushpins", + "type": "string" + } + }, + "required": [ + "executionResult" + ], + "type": "object" + }, + "TabularExportRequest": { + "description": "Export request object describing the export properties and overrides for tabular exports.", + "properties": { + "conditionalFormatting": { + "$ref": "#/components/schemas/ConditionalFormatting" + }, + "customOverride": { + "$ref": "#/components/schemas/CustomOverride" + }, + "executionResult": { + "description": "Execution result identifier.", + "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", + "type": "string" + }, + "executionSettings": { + "$ref": "#/components/schemas/ExecutionSettings" + }, + "executions": { + "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", + "items": { + "$ref": "#/components/schemas/TabularExportExecution" + }, + "type": "array" + }, + "fileName": { + "description": "Filename of downloaded file without extension.", + "example": "result", + "type": "string" + }, + "format": { + "description": "Expected file format.", + "enum": [ + "CSV", + "XLSX", + "HTML", + "PDF" + ], + "example": "CSV", + "type": "string" + }, + "metadata": { + "$ref": "#/components/schemas/JsonNode" + }, + "relatedDashboardId": { + "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "settings": { + "$ref": "#/components/schemas/Settings" + }, + "visualizationObject": { + "description": "Visualization object identifier. Alternative to executionResult property.", + "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", + "type": "string" + }, + "visualizationObjectCustomFilters": { + "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", + "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", + "items": { + "type": "object" + }, + "type": "array" + }, + "visualizationObjectCustomParameters": { + "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", + "items": { + "$ref": "#/components/schemas/ParameterValue" + }, + "type": "array" + } + }, + "required": [ + "fileName", + "format" + ], + "type": "object" + }, + "TelemetryConfig": { + "description": "Telemetry-related configuration.", + "properties": { + "context": { + "$ref": "#/components/schemas/TelemetryContext" + }, + "services": { + "$ref": "#/components/schemas/TelemetryServices" + } + }, + "required": [ + "context", + "services" + ], + "type": "object" + }, + "TelemetryContext": { + "description": "The telemetry context.", + "properties": { + "deploymentId": { + "description": "Identification of the deployment.", + "type": "string" + }, + "organizationHash": { + "description": "Organization hash.", + "type": "string" + }, + "userHash": { + "description": "User hash.", + "type": "string" + } + }, + "required": [ + "deploymentId", + "organizationHash", + "userHash" + ], + "type": "object" + }, + "TelemetryServices": { + "description": "Available telemetry services.", + "properties": { + "amplitude": { + "$ref": "#/components/schemas/AmplitudeService" + }, + "matomo": { + "$ref": "#/components/schemas/MatomoService" + }, + "openTelemetry": { + "$ref": "#/components/schemas/OpenTelemetryService" + } + }, + "type": "object" + }, + "UserAssignee": { + "description": "List of users", + "properties": { + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "description": "User name", + "example": "John Wick", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UserGroupAssignee": { + "description": "List of user groups", + "properties": { + "id": { + "type": "string" + }, + "name": { + "description": "User group name", + "example": "admins", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UserGroupIdentifier": { + "description": "A list of groups where user is a member", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UserGroupPermission": { + "description": "List of user groups", + "properties": { + "id": { + "type": "string" + }, + "name": { + "description": "Name of the user group", + "example": "admins", + "type": "string" + }, + "permissions": { + "description": "Permissions granted to the user group", + "items": { + "$ref": "#/components/schemas/GrantedPermission" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UserManagementDataSourcePermissionAssignment": { + "description": "Datasource permission assignments for users and userGroups", + "properties": { + "accessSource": { + "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP" + ], + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Id of the datasource", + "type": "string" + }, + "name": { + "description": "Name of the datasource", + "readOnly": true, + "type": "string" + }, + "permissions": { + "items": { + "enum": [ + "MANAGE", + "USE" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "id", + "permissions" + ], + "type": "object" + }, + "UserManagementPermissionAssignments": { + "properties": { + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "dataSources", + "workspaces" + ], + "type": "object" + }, + "UserManagementUserGroupMember": { + "properties": { + "id": { + "type": "string" + }, + "name": { + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "UserManagementUserGroupMembers": { + "properties": { + "members": { + "items": { + "$ref": "#/components/schemas/UserManagementUserGroupMember" + }, + "type": "array" + } + }, + "required": [ + "members" + ], + "type": "object" + }, + "UserManagementUserGroups": { + "properties": { + "totalCount": { + "description": "Total number of groups", + "format": "int32", + "type": "integer" + }, + "userGroups": { + "items": { + "$ref": "#/components/schemas/UserManagementUserGroupsItem" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "userGroups" + ], + "type": "object" + }, + "UserManagementUserGroupsItem": { + "description": "List of groups", + "properties": { + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "id": { + "type": "string" + }, + "name": { + "description": "Group name", + "example": "admins", + "type": "string" + }, + "organizationAdmin": { + "description": "Is group organization admin", + "example": false, + "type": "boolean" + }, + "userCount": { + "description": "The number of users belonging to the group", + "format": "int32", + "type": "integer" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "dataSources", + "id", + "organizationAdmin", + "userCount", + "workspaces" + ], + "type": "object" + }, + "UserManagementUsers": { + "properties": { + "totalCount": { + "description": "The total number of users is based on applied filters.", + "format": "int32", + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/components/schemas/UserManagementUsersItem" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "users" + ], + "type": "object" + }, + "UserManagementUsersItem": { + "description": "List of users", + "properties": { + "dataSources": { + "items": { + "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" + }, + "type": "array" + }, + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "description": "User name", + "example": "John Wick", + "type": "string" + }, + "organizationAdmin": { + "description": "Is user organization admin", + "example": false, + "type": "boolean" + }, + "systemAccount": { + "description": "Is user system account", + "example": false, + "type": "boolean" + }, + "userGroups": { + "items": { + "$ref": "#/components/schemas/UserGroupIdentifier" + }, + "type": "array" + }, + "workspaces": { + "items": { + "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" + }, + "type": "array" + } + }, + "required": [ + "dataSources", + "id", + "organizationAdmin", + "systemAccount", + "userGroups", + "workspaces" + ], + "type": "object" + }, + "UserManagementWorkspacePermissionAssignment": { + "description": "Workspace permission assignments for users and userGroups", + "properties": { + "accessSource": { + "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", + "enum": [ + "DIRECT", + "GROUP", + "HIERARCHY" + ], + "readOnly": true, + "type": "string" + }, + "hierarchyPermissions": { + "items": { + "enum": [ + "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" + }, + "id": { + "type": "string" + }, + "name": { + "readOnly": true, + "type": "string" + }, + "permissions": { + "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" + } + }, + "required": [ + "hierarchyPermissions", + "id", + "permissions" + ], + "type": "object" + }, + "UserPermission": { + "description": "List of users", + "properties": { + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "description": "Name of user", + "example": "John Wick", + "type": "string" + }, + "permissions": { + "description": "Permissions granted to the user", + "items": { + "$ref": "#/components/schemas/GrantedPermission" + }, + "type": "array" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "ValidityPeriodCacheRetention": { + "description": "The cache expires once a fixed period elapses since the results were computed.", + "properties": { + "type": { + "description": "The cache retention type.", + "enum": [ + "VALIDITY_PERIOD" + ], + "type": "string" + }, + "validityPeriod": { + "description": "How long the cached results stay valid after they were computed.", + "example": "P1D", + "format": "duration", + "type": "string" + } + }, + "required": [ + "type", + "validityPeriod" + ], + "type": "object" + }, + "Value": { + "properties": { + "value": { + "description": "Value of the alert threshold to compare the metric to.", + "example": 1000, + "type": "number" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "VisibleFilter": { + "properties": { + "isAllTimeDateFilter": { + "default": false, + "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", + "type": "boolean" + }, + "localIdentifier": { + "type": "string" + }, + "title": { + "type": "string" + } + }, + "type": "object" + }, + "VisualExportRequest": { + "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", + "properties": { + "dashboardId": { + "description": "Dashboard identifier", + "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", + "type": "string" + }, + "fileName": { + "description": "File name to be used for retrieving the pdf document.", + "example": "filename", + "type": "string" + }, + "metadata": { + "description": "Metadata definition in free-form JSON format.", + "example": "{}", + "type": "object" + }, + "timezoneId": { + "description": "Time zone the export should be rendered in, as an IANA identifier (e.g. 'Asia/Kolkata') or a GMT offset (e.g. 'GMT+01:00'). When omitted, the workspace time zone setting is used.", + "example": "Asia/Kolkata", + "nullable": true, + "type": "string" + } + }, + "required": [ + "dashboardId", + "fileName" + ], + "type": "object" + }, + "VisualizationPermissions": { + "properties": { + "rules": { + "description": "List of rules", + "items": { + "$ref": "#/components/schemas/RulePermission" + }, + "type": "array" + }, + "userGroups": { + "description": "List of user groups", + "items": { + "$ref": "#/components/schemas/UserGroupPermission" + }, + "type": "array" + }, + "users": { + "description": "List of users", + "items": { + "$ref": "#/components/schemas/UserPermission" + }, + "type": "array" + } + }, + "required": [ + "rules", + "userGroups", + "users" + ], + "type": "object" + }, + "VisualizationPermissionsAssignment": { + "description": "Desired levels of permissions on a visualization for an assignee.", + "properties": { + "permissions": { + "items": { + "enum": [ + "EDIT", + "SHARE", + "VIEW" + ], + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "permissions" + ], + "type": "object" + }, + "VisualizationPermissionsForAssignee": { + "allOf": [ + { + "$ref": "#/components/schemas/VisualizationPermissionsAssignment" + }, + { + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + } + }, + "type": "object" + } + ], + "description": "Desired levels of visualization permissions for an assignee identified by an identifier.", + "required": [ + "assigneeIdentifier", + "permissions" + ], + "type": "object" + }, + "VisualizationPermissionsForAssigneeRule": { + "allOf": [ + { + "$ref": "#/components/schemas/VisualizationPermissionsAssignment" + }, + { + "properties": { + "assigneeRule": { + "$ref": "#/components/schemas/AssigneeRule" + } + }, + "type": "object" + } + ], + "description": "Desired levels of visualization permissions for a collection of assignees identified by a rule.", + "required": [ + "assigneeRule", + "permissions" + ], + "type": "object" + }, + "Webhook": { + "allOf": [ + { + "properties": { + "hasSecretKey": { + "description": "Flag indicating if webhook has a hmac secret key.", + "maxLength": 10000, + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "hasToken": { + "description": "Flag indicating if webhook has a token.", + "maxLength": 10000, + "nullable": true, + "readOnly": true, + "type": "boolean" + }, + "secretKey": { + "description": "Hmac secret key for the webhook signature.", + "example": "secret_key", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "token": { + "description": "Bearer token for the webhook.", + "example": "secret", + "maxLength": 10000, + "nullable": true, + "type": "string", + "writeOnly": true + }, + "type": { + "description": "The destination type.", + "enum": [ + "WEBHOOK" + ], + "type": "string" + }, + "url": { + "description": "The webhook URL.", + "example": "https://webhook.site/something", + "maxLength": 255, + "pattern": "https?\\://.*", + "type": "string" + } + }, + "type": "object" + } + ], + "description": "Webhook destination for notifications. The property url is required on create and update.", + "required": [ + "type" + ], + "type": "object" + }, + "WidgetSlidesTemplate": { + "description": "Template for 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" + }, + "WorkspaceAutomationIdentifier": { + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceAutomationManagementBulkRequest": { + "properties": { + "automations": { + "items": { + "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" + }, + "type": "array" + } + }, + "required": [ + "automations" + ], + "type": "object" + }, + "WorkspaceDashboardSlidesTemplate": { + "description": "Template for workspace dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + }, + "coverSlide": { + "$ref": "#/components/schemas/CoverSlideTemplate" + }, + "introSlide": { + "$ref": "#/components/schemas/IntroSlideTemplate" + }, + "sectionSlide": { + "$ref": "#/components/schemas/SectionSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "WorkspaceDataSource": { + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", + "properties": { + "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" + }, + "WorkspaceIdentifier": { + "description": "A workspace identifier.", + "example": "{ id: demo, type: workspace }", + "properties": { + "id": { + "description": "Identifier of the workspace.", + "example": "alpha.sales", + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + }, + "type": { + "description": "A type.", + "enum": [ + "workspace" + ], + "example": "workspace", + "type": "string" + } + }, + "required": [ + "id", + "type" + ], + "type": "object" + }, + "WorkspacePermissionAssignment": { + "description": "Workspace permission assignments", + "properties": { + "assigneeIdentifier": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "hierarchyPermissions": { + "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" + }, + "permissions": { + "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" + } + }, + "required": [ + "assigneeIdentifier" + ], + "type": "object" + }, + "WorkspaceUser": { + "description": "List of workspace users", + "properties": { + "email": { + "description": "User email address", + "example": "user@example.com", + "type": "string" + }, + "id": { + "type": "string" + }, + "name": { + "description": "User name", + "example": "John Wick", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceUserGroup": { + "description": "List of workspace groups", + "properties": { + "id": { + "type": "string" + }, + "name": { + "description": "Group name", + "example": "admins", + "type": "string" + } + }, + "required": [ + "id" + ], + "type": "object" + }, + "WorkspaceUserGroups": { + "properties": { + "totalCount": { + "description": "Total number of groups", + "format": "int32", + "type": "integer" + }, + "userGroups": { + "items": { + "$ref": "#/components/schemas/WorkspaceUserGroup" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "userGroups" + ], + "type": "object" + }, + "WorkspaceUsers": { + "properties": { + "totalCount": { + "description": "The total number of users is based on applied filters.", + "format": "int32", + "type": "integer" + }, + "users": { + "items": { + "$ref": "#/components/schemas/WorkspaceUser" + }, + "type": "array" + } + }, + "required": [ + "totalCount", + "users" + ], + "type": "object" + }, + "WorkspaceWidgetSlidesTemplate": { + "description": "Template for workspace widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", + "nullable": true, + "properties": { + "appliedOn": { + "description": "Export types this template applies to.", + "example": [ + "PDF", + "PPTX" + ], + "items": { + "enum": [ + "PDF", + "PPTX" + ], + "type": "string" + }, + "minItems": 1, + "type": "array" + }, + "contentSlide": { + "$ref": "#/components/schemas/ContentSlideTemplate" + } + }, + "required": [ + "appliedOn" + ], + "type": "object" + }, + "Xliff": { + "properties": { + "file": { + "items": { + "$ref": "#/components/schemas/File" + }, + "type": "array" + }, + "otherAttributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "space": { + "type": "string", + "xml": { + "attribute": true, + "namespace": "http://www.w3.org/XML/1998/namespace" + } + }, + "srcLang": { + "type": "string", + "xml": { + "attribute": true + } + }, + "trgLang": { + "type": "string", + "xml": { + "attribute": true + } + }, + "version": { + "type": "string", + "xml": { + "attribute": true + } + } + }, + "required": [ + "file" + ], + "type": "object", + "xml": { + "name": "xliff", + "namespace": "urn:oasis:names:tc:xliff:document:2.0" + } + } + } + }, + "info": { + "title": "OpenAPI definition", + "version": "v0" + }, + "openapi": "3.0.1", + "paths": { + "/api/v1/actions/collectUsage": { + "get": { + "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", + "operationId": "allPlatformUsage", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/PlatformUsage" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "Info about the platform usage.", + "tags": [ + "Usage", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", + "operationId": "particularPlatformUsage", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlatformUsageRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/PlatformUsage" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "Info about the platform usage for particular items.", + "tags": [ + "Usage", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel": { + "post": { + "description": "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", + "operationId": "generateLogicalModel", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GenerateLdmRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeclarativeModel" + } + } + }, + "description": "LDM generated successfully." + } + }, + "summary": "Generate logical data model (LDM) from physical data model (PDM)", + "tags": [ + "Generate Logical Data Model", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/managePermissions": { + "post": { + "description": "Manage Permissions for a Data Source", + "operationId": "manageDataSourcePermissions", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of data source permissions assignments", + "items": { + "$ref": "#/components/schemas/DataSourcePermissionAssignment" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Manage Permissions for a Data Source", + "tags": [ + "Manage Permissions", + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { + "post": { + "description": "Notification sets up all reports to be computed again with new data.", + "operationId": "registerUploadNotification", + "parameters": [ + { + "in": "path", + "name": "dataSourceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "An upload notification has been successfully registered." + } + }, + "summary": "Register an upload notification", + "tags": [ + "Invalidate Cache", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/invite": { + "post": { + "description": "Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.", + "operationId": "processInvitation", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Invitation" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Invite User", + "tags": [ + "User Authorization", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to add an invitation.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/ipAllowlistPolicies/{id}/addTargets": { + "post": { + "operationId": "addTargets", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IpAllowlistPolicyTargets" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Add targets to IP allowlist policy", + "tags": [ + "Organization - Entity APIs", + "actions" + ] + } + }, + "/api/v1/actions/ipAllowlistPolicies/{id}/removeTargets": { + "post": { + "operationId": "removeTargets", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IpAllowlistPolicyTargets" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Remove targets from IP allowlist policy", + "tags": [ + "Organization - Entity APIs", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/delete": { + "post": { + "operationId": "deleteOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Delete selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/pause": { + "post": { + "operationId": "pauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Pause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/unpause": { + "post": { + "operationId": "unpauseOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unpause selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/automations/unsubscribe": { + "delete": { + "operationId": "unsubscribeAllAutomations", + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unsubscribe from all automations in all workspaces", + "tags": [ + "Automations", + "actions" + ] + }, + "post": { + "operationId": "unsubscribeOrganizationAutomations", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unsubscribe from selected automations across all workspaces", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/organization/managePermissions": { + "post": { + "description": "Manage Permissions for a Organization", + "operationId": "manageOrganizationPermissions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "An array of organization permissions assignments", + "items": { + "$ref": "#/components/schemas/OrganizationPermissionAssignment" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Manage Permissions for a Organization", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/organization/reloadObservabilityLayout": { + "post": { + "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", + "operationId": "reloadObservabilityLayout", + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Reload the managed AI observability layout", + "tags": [ + "Observability", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/organization/switchActiveIdentityProvider": { + "post": { + "description": "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", + "operationId": "switchActiveIdentityProvider", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwitchIdentityProviderRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Switch Active Identity Provider", + "tags": [ + "Identity Providers", + "actions" + ] + } + }, + "/api/v1/actions/organization/syncMetadata": { + "post": { + "description": "Enqueues an organization-scoped metadata resync, fanning out the organization's current metadata to GenAI, GW Forge, and Automations. Requires organization MANAGE permission. Requests are deduplicated while a resync session is pending for the organization.", + "operationId": "syncMetadata", + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Trigger metadata synchronization", + "tags": [ + "Metadata Synchronization", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/resolveEntitlements": { + "get": { + "description": "Resolves values of available entitlements for the organization.", + "operationId": "resolveAllEntitlements", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ApiEntitlement" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "Values for all public entitlements.", + "tags": [ + "Entitlement", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "description": "Resolves values for requested entitlements in the organization.", + "operationId": "resolveRequestedEntitlements", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EntitlementsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ApiEntitlement" + }, + "type": "array" + } + } + }, + "description": "OK" + } + }, + "summary": "Values for requested public entitlements.", + "tags": [ + "Entitlement", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/actions/resolveSettings": { + "get": { + "description": "Resolves values for all settings without workspace by current user, organization, or default settings.", + "operationId": "resolveAllSettingsWithoutWorkspace", + "parameters": [ + { + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" + } + } + }, + "description": "Values for selected settings." + } + }, + "summary": "Values for all settings without workspace.", + "tags": [ + "Reporting - Settings", + "actions" + ] + }, + "post": { + "description": "Resolves values for selected settings without workspace by current user, organization, or default settings.", + "operationId": "resolveSettingsWithoutWorkspace", + "parameters": [ + { + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ResolveSettingsRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" + } + } + }, + "description": "Values for selected settings." + } + }, + "summary": "Values for selected settings without workspace.", + "tags": [ + "Reporting - Settings", + "actions" + ] + } + }, + "/api/v1/actions/userManagement/assignPermissions": { + "post": { + "operationId": "assignPermissions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionsAssignment" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "OK" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/removeUsersUserGroups": { + "post": { + "operationId": "removeUsersUserGroups", + "requestBody": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/AssigneeIdentifier" + }, + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "OK" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/revokePermissions": { + "post": { + "operationId": "revokePermissions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PermissionsAssignment" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": {}, + "description": "OK" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/userGroups": { + "get": { + "operationId": "listUserGroups", + "parameters": [ + { + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name. Note that user name is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter by workspaceId.", + "example": "workspace=demo", + "in": "query", + "name": "workspace", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "Filter by dataSourceId.", + "example": "dataSource=demo-test-ds", + "in": "query", + "name": "dataSource", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUserGroups" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers": { + "post": { + "operationId": "addGroupMembers", + "parameters": [ + { + "in": "path", + "name": "userGroupId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUserGroupMembers" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/userGroups/{userGroupId}/members": { + "get": { + "operationId": "getGroupMembers", + "parameters": [ + { + "in": "path", + "name": "userGroupId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUserGroupMembers" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions": { + "get": { + "operationId": "listPermissionsForUserGroup", + "parameters": [ + { + "in": "path", + "name": "userGroupId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementPermissionAssignments" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "User management" + ] + }, + "post": { + "operationId": "managePermissionsForUserGroup", + "parameters": [ + { + "in": "path", + "name": "userGroupId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementPermissionAssignments" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers": { + "post": { + "operationId": "removeGroupMembers", + "parameters": [ + { + "in": "path", + "name": "userGroupId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUserGroupMembers" + } + } + }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/userManagement/users": { + "get": { + "operationId": "listUsers", + "parameters": [ + { + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" }, - "minItems": 1, - "type": "array" + "style": "form" }, - "contentSlide": { - "$ref": "#/components/schemas/ContentSlideTemplate" - } - }, - "required": [ - "appliedOn" - ], - "type": "object" - }, - "Xliff": { - "properties": { - "file": { - "items": { - "$ref": "#/components/schemas/File" + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" }, - "type": "array" + "style": "form" }, - "otherAttributes": { - "additionalProperties": { + { + "description": "Filter by user name. Note that user name is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, + "schema": { "type": "string" }, - "type": "object" - }, - "space": { - "type": "string", - "xml": { - "attribute": true, - "namespace": "http://www.w3.org/XML/1998/namespace" - } + "style": "form" }, - "srcLang": { - "type": "string", - "xml": { - "attribute": true - } + { + "description": "Filter by workspaceId.", + "example": "workspace=demo", + "in": "query", + "name": "workspace", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" }, - "trgLang": { - "type": "string", - "xml": { - "attribute": true - } + { + "description": "Filter by userGroupId.", + "example": "group=admin", + "in": "query", + "name": "group", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" }, - "version": { - "type": "string", - "xml": { - "attribute": true - } + { + "description": "Filter by dataSourceId.", + "example": "dataSource=demo-test-ds", + "in": "query", + "name": "dataSource", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" } - }, - "required": [ - "file" ], - "type": "object", - "xml": { - "name": "xliff", - "namespace": "urn:oasis:names:tc:xliff:document:2.0" - } + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserManagementUsers" + } + } + }, + "description": "OK" + } + }, + "tags": [ + "User management" + ] } - } - }, - "info": { - "title": "OpenAPI definition", - "version": "v0" - }, - "openapi": "3.0.1", - "paths": { - "/api/v1/actions/collectUsage": { + }, + "/api/v1/actions/userManagement/users/{userId}/permissions": { "get": { - "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", - "operationId": "allPlatformUsage", + "operationId": "listPermissionsForUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", + "example": "includeInherited=true", + "in": "query", + "name": "includeInherited", + "required": false, + "schema": { + "default": false, + "type": "boolean" + }, + "style": "form" + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/PlatformUsage" - }, - "type": "array" + "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "description": "OK" } }, - "summary": "Info about the platform usage.", "tags": [ - "Usage", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "User management" + ] }, "post": { - "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", - "operationId": "particularPlatformUsage", + "operationId": "managePermissionsForUser", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PlatformUsageRequest" + "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "required": true }, + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "tags": [ + "User management" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { + "get": { + "description": "Returns a list of Users who created any object for this workspace", + "operationId": "createdBy", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/PlatformUsage" - }, - "type": "array" + "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" } } }, "description": "OK" } }, - "summary": "Info about the platform usage for particular items.", + "summary": "Get Analytics Catalog CreatedBy Users", "tags": [ - "Usage", + "Smart Functions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel": { - "post": { - "description": "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", - "operationId": "generateLogicalModel", + "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { + "get": { + "description": "Returns a list of tags for this workspace", + "operationId": "tags", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GenerateLdmRequest" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnalyticsCatalogTags" + } } + }, + "description": "OK" + } + }, + "summary": "Get Analytics Catalog Tags", + "tags": [ + "Smart Functions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { + "get": { + "operationId": "availableAssignees", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } }, - "required": true - }, + { + "in": "path", + "name": "dashboardId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DeclarativeModel" + "$ref": "#/components/schemas/AvailableAssignees" } } }, - "description": "LDM generated successfully." + "description": "OK" } }, - "summary": "Generate logical data model (LDM) from physical data model (PDM)", + "summary": "Get Available Assignees", "tags": [ - "Generate Logical Data Model", + "Permissions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/managePermissions": { + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions": { "post": { - "description": "Manage Permissions for a Data Source", - "operationId": "manageDataSourcePermissions", + "operationId": "manageDashboardPermissions", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "dashboardId", "required": true, "schema": { "type": "string" @@ -31557,9 +39664,16 @@ "content": { "application/json": { "schema": { - "description": "An array of data source permissions assignments", + "description": "An array of dashboard permissions assignments", "items": { - "$ref": "#/components/schemas/DataSourcePermissionAssignment" + "oneOf": [ + { + "$ref": "#/components/schemas/PermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/PermissionsForAssigneeRule" + } + ] }, "type": "array" } @@ -31573,22 +39687,28 @@ "description": "No Content" } }, - "summary": "Manage Permissions for a Data Source", + "summary": "Manage Permissions for a Dashboard", "tags": [ - "Manage Permissions", "Permissions", "actions" ] } }, - "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { - "post": { - "description": "Notification sets up all reports to be computed again with new data.", - "operationId": "registerUploadNotification", + "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions": { + "get": { + "operationId": "dashboardPermissions", "parameters": [ { "in": "path", - "name": "dataSourceId", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "dashboardId", "required": true, "schema": { "type": "string" @@ -31596,31 +39716,39 @@ } ], "responses": { - "204": { - "content": {}, - "description": "An upload notification has been successfully registered." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DashboardPermissions" + } + } + }, + "description": "OK" } }, - "summary": "Register an upload notification", + "summary": "Get Dashboard Permissions", "tags": [ - "Invalidate Cache", + "Permissions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + ] } }, - "/api/v1/actions/ipAllowlistPolicies/{id}/addTargets": { + "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions": { "post": { - "operationId": "addTargets", + "operationId": "manageAttributePermissions", "parameters": [ { "in": "path", - "name": "id", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "attributeId", "required": true, "schema": { "type": "string" @@ -31631,7 +39759,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IpAllowlistPolicyTargets" + "description": "An array of attribute-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/AttributePermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/AttributePermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, @@ -31643,20 +39782,60 @@ "description": "No Content" } }, - "summary": "Add targets to IP allowlist policy", + "summary": "Manage Permissions for an Attribute", "tags": [ - "Organization - Entity APIs", + "Permissions", "actions" ] } }, - "/api/v1/actions/ipAllowlistPolicies/{id}/removeTargets": { + "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions": { + "get": { + "operationId": "attributePermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "attributeId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttributePermissions" + } + } + }, + "description": "OK" + } + }, + "summary": "Get Attribute Permissions", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { "post": { - "operationId": "removeTargets", + "operationId": "deleteWorkspaceAutomations", "parameters": [ { "in": "path", - "name": "id", + "name": "workspaceId", "required": true, "schema": { "type": "string" @@ -31667,7 +39846,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/IpAllowlistPolicyTargets" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, @@ -31679,21 +39858,31 @@ "description": "No Content" } }, - "summary": "Remove targets from IP allowlist policy", + "summary": "Delete selected automations in the workspace", "tags": [ - "Organization - Entity APIs", + "Automations", "actions" ] } }, - "/api/v1/actions/organization/automations/delete": { + "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { "post": { - "operationId": "deleteOrganizationAutomations", + "operationId": "pauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, @@ -31705,21 +39894,31 @@ "description": "No Content" } }, - "summary": "Delete selected automations across all workspaces", + "summary": "Pause selected automations in the workspace", "tags": [ "Automations", "actions" ] } }, - "/api/v1/actions/organization/automations/pause": { + "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { "post": { - "operationId": "pauseOrganizationAutomations", + "operationId": "unpauseWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, @@ -31731,21 +39930,55 @@ "description": "No Content" } }, - "summary": "Pause selected automations across all workspaces", + "summary": "Unpause selected automations in the workspace", + "tags": [ + "Automations", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { + "delete": { + "operationId": "unsubscribeWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "content": {}, + "description": "No Content" + } + }, + "summary": "Unsubscribe from all automations in the workspace", "tags": [ "Automations", "actions" ] - } - }, - "/api/v1/actions/organization/automations/unpause": { + }, "post": { - "operationId": "unpauseOrganizationAutomations", + "operationId": "unsubscribeSelectedWorkspaceAutomations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, @@ -31757,64 +39990,138 @@ "description": "No Content" } }, - "summary": "Unpause selected automations across all workspaces", + "summary": "Unsubscribe from selected automations in the workspace", "tags": [ "Automations", "actions" ] } }, - "/api/v1/actions/organization/automations/unsubscribe": { + "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { "delete": { - "operationId": "unsubscribeAllAutomations", + "operationId": "unsubscribeAutomation", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "automationId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "204": { "content": {}, "description": "No Content" } }, - "summary": "Unsubscribe from all automations in all workspaces", + "summary": "Unsubscribe from an automation", "tags": [ "Automations", "actions" ] - }, + } + }, + "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides": { "post": { - "operationId": "unsubscribeOrganizationAutomations", + "description": "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", + "operationId": "checkEntityOverrides", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" + "description": "An array of object identifications", + "items": { + "$ref": "#/components/schemas/HierarchyObjectIdentification" + }, + "type": "array" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/IdentifierDuplications" + }, + "type": "array" + } + } + }, + "description": "Searching for entities finished successfully." } }, - "summary": "Unsubscribe from selected automations across all workspaces", + "summary": "Finds entities with given ID in hierarchy.", "tags": [ - "Automations", + "Hierarchy", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/actions/organization/managePermissions": { + "/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/managePermissions": { "post": { - "description": "Manage Permissions for a Organization", - "operationId": "manageOrganizationPermissions", + "operationId": "manageComputedAttributePermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "computedAttributeId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "An array of organization permissions assignments", + "description": "An array of computed-attribute-permission assignments.", "items": { - "$ref": "#/components/schemas/OrganizationPermissionAssignment" + "oneOf": [ + { + "$ref": "#/components/schemas/ComputedAttributePermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/ComputedAttributePermissionsForAssigneeRule" + } + ] }, "type": "array" } @@ -31828,45 +40135,176 @@ "description": "No Content" } }, - "summary": "Manage Permissions for a Organization", + "summary": "(BETA) Manage Permissions for a Computed Attribute", "tags": [ "Permissions", "actions" ] } }, - "/api/v1/actions/organization/reloadObservabilityLayout": { + "/api/v1/actions/workspaces/{workspaceId}/computedAttributes/{computedAttributeId}/permissions": { + "get": { + "operationId": "computedAttributePermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "computedAttributeId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ComputedAttributePermissions" + } + } + }, + "description": "OK" + } + }, + "summary": "(BETA) Get Computed Attribute Permissions", + "tags": [ + "Permissions", + "actions" + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph": { + "get": { + "description": "Computes the dependent entities graph", + "operationId": "getDependentEntitiesGraph", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DependentEntitiesResponse" + } + } + }, + "description": "Computes the dependent entities graph" + } + }, + "summary": "Computes the dependent entities graph", + "tags": [ + "Dependency Graph", + "actions" + ], + "x-gdc-security-info": { + "description": "Permissions required to read the graph.", + "permissions": [ + "VIEW" + ] + } + }, "post": { - "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", - "operationId": "reloadObservabilityLayout", + "description": "Computes the dependent entities graph from given entry points", + "operationId": "getDependentEntitiesGraphFromEntryPoints", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DependentEntitiesRequest" + } + } + }, + "required": true + }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DependentEntitiesResponse" + } + } + }, + "description": "Computes the dependent entities graph from given entry points" } }, - "summary": "Reload the managed AI observability layout", + "summary": "Computes the dependent entities graph from given entry points", "tags": [ - "AI Observability", + "Dependency Graph", "actions" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Permissions required to read the graph.", "permissions": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/actions/organization/switchActiveIdentityProvider": { + "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions": { "post": { - "description": "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", - "operationId": "switchActiveIdentityProvider", + "operationId": "manageFactPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "factId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwitchIdentityProviderRequest" + "description": "An array of fact-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/FactPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/FactPermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, @@ -31878,98 +40316,106 @@ "description": "No Content" } }, - "summary": "Switch Active Identity Provider", + "summary": "Manage Permissions for a Fact", "tags": [ - "Identity Providers", + "Permissions", "actions" ] } }, - "/api/v1/actions/resolveEntitlements": { + "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions": { "get": { - "description": "Resolves values of available entitlements for the organization.", - "operationId": "resolveAllEntitlements", + "operationId": "factPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "factId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ApiEntitlement" - }, - "type": "array" + "$ref": "#/components/schemas/FactPermissions" } } }, "description": "OK" } }, - "summary": "Values for all public entitlements.", + "summary": "Get Fact Permissions", "tags": [ - "Entitlement", + "Permissions", "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } - }, - "post": { - "description": "Resolves values for requested entitlements in the organization.", - "operationId": "resolveRequestedEntitlements", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitlementsRequest" - } + ] + } + }, + "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts": { + "get": { + "description": "Finds API identifier conflicts in given workspace hierarchy.", + "operationId": "inheritedEntityConflicts", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } - }, - "required": true - }, + } + ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/ApiEntitlement" + "$ref": "#/components/schemas/IdentifierDuplications" }, "type": "array" } } }, - "description": "OK" + "description": "Searching for conflicting identifiers finished successfully" } }, - "summary": "Values for requested public entitlements.", + "summary": "Finds identifier conflicts in workspace hierarchy.", "tags": [ - "Entitlement", + "Hierarchy", "actions" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/actions/resolveSettings": { + "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes": { "get": { - "description": "Resolves values for all settings without workspace by current user, organization, or default settings.", - "operationId": "resolveAllSettingsWithoutWorkspace", + "description": "Get used entity prefixes in hierarchy of parent workspaces", + "operationId": "inheritedEntityPrefixes", "parameters": [ { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], @@ -31979,33 +40425,46 @@ "application/json": { "schema": { "items": { - "$ref": "#/components/schemas/ResolvedSetting" + "type": "string" }, "type": "array" } } }, - "description": "Values for selected settings." + "description": "Prefixes used in parent entities" } }, - "summary": "Values for all settings without workspace.", + "summary": "Get used entity prefixes in hierarchy", "tags": [ - "Reporting - Settings", + "Hierarchy", "actions" - ] - }, + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions": { "post": { - "description": "Resolves values for selected settings without workspace by current user, organization, or default settings.", - "operationId": "resolveSettingsWithoutWorkspace", + "operationId": "manageLabelPermissions", "parameters": [ { - "description": "If true, user-level settings are excluded from resolution.", - "in": "query", - "name": "excludeUserSettings", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": false, - "type": "boolean" + "type": "string" + } + }, + { + "in": "path", + "name": "labelId", + "required": true, + "schema": { + "type": "string" } } ], @@ -32013,67 +40472,97 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResolveSettingsRequest" + "description": "An array of label-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/LabelPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/LabelPermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, "required": true }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" - } - } - }, - "description": "Values for selected settings." + "204": { + "content": {}, + "description": "No Content" } }, - "summary": "Values for selected settings without workspace.", + "summary": "Manage Permissions for a Label", "tags": [ - "Reporting - Settings", + "Permissions", "actions" ] } }, - "/api/v1/actions/userManagement/assignPermissions": { - "post": { - "operationId": "assignPermissions", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PermissionsAssignment" - } + "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions": { + "get": { + "operationId": "labelPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" } }, - "required": true - }, + { + "in": "path", + "name": "labelId", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "content": {}, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LabelPermissions" + } + } + }, "description": "OK" } }, + "summary": "Get Label Permissions", "tags": [ - "User management" + "Permissions", + "actions" ] } }, - "/api/v1/actions/userManagement/removeUsersUserGroups": { + "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { "post": { - "operationId": "removeUsersUserGroups", + "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", + "operationId": "manageWorkspacePermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { + "description": "An array of workspace permissions assignments", "items": { - "$ref": "#/components/schemas/AssigneeIdentifier" + "$ref": "#/components/schemas/WorkspacePermissionAssignment" }, "type": "array" } @@ -32082,102 +40571,92 @@ "required": true }, "responses": { - "200": { + "204": { "content": {}, - "description": "OK" + "description": "No Content" } }, + "summary": "Manage Permissions for a Workspace", "tags": [ - "User management" + "Permissions", + "actions" ] } }, - "/api/v1/actions/userManagement/revokePermissions": { + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions": { "post": { - "operationId": "revokePermissions", + "operationId": "manageMetricPermissions", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "metricId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PermissionsAssignment" + "description": "An array of metric-permission assignments.", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/MetricPermissionsForAssignee" + }, + { + "$ref": "#/components/schemas/MetricPermissionsForAssigneeRule" + } + ] + }, + "type": "array" } } }, "required": true }, "responses": { - "200": { + "204": { "content": {}, - "description": "OK" + "description": "No Content" } }, + "summary": "(BETA) Manage Permissions for a Metric", "tags": [ - "User management" + "Permissions", + "actions" ] } }, - "/api/v1/actions/userManagement/userGroups": { + "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions": { "get": { - "operationId": "listUserGroups", + "operationId": "metricPermissions", "parameters": [ { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by workspaceId.", - "example": "workspace=demo", - "in": "query", - "name": "workspace", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { "type": "string" - }, - "style": "form" + } }, { - "description": "Filter by dataSourceId.", - "example": "dataSource=demo-test-ds", - "in": "query", - "name": "dataSource", - "required": false, + "in": "path", + "name": "metricId", + "required": true, "schema": { "type": "string" - }, - "style": "form" + } } ], "responses": { @@ -32185,59 +40664,28 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroups" + "$ref": "#/components/schemas/MetricPermissions" } } }, "description": "OK" } }, + "summary": "(BETA) Get Metric Permissions", "tags": [ - "User management" - ] - } - }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers": { - "post": { - "operationId": "addGroupMembers", - "parameters": [ - { - "in": "path", - "name": "userGroupId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" - } - } - }, - "required": true - }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "tags": [ - "User management" + "Permissions", + "actions" ] } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/members": { + "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities": { "get": { - "operationId": "getGroupMembers", + "description": "Finds API identifier overrides in given workspace hierarchy.", + "operationId": "overriddenChildEntities", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { "type": "string" @@ -32249,41 +40697,51 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" + "items": { + "$ref": "#/components/schemas/IdentifierDuplications" + }, + "type": "array" } } }, - "description": "OK" + "description": "Searching for overridden identifiers finished successfully" } }, + "summary": "Finds identifier overrides in workspace hierarchy.", "tags": [ - "User management" - ] + "Hierarchy", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions": { + "/api/v1/actions/workspaces/{workspaceId}/resolveSettings": { "get": { - "operationId": "listPermissionsForUserGroup", + "description": "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", + "operationId": "workspaceResolveAllSettings", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", - "example": "includeInherited=true", + "description": "If true, user-level settings are excluded from resolution.", "in": "query", - "name": "includeInherited", + "name": "excludeUserSettings", "required": false, "schema": { "default": false, "type": "boolean" - }, - "style": "form" + } } ], "responses": { @@ -32291,57 +40749,97 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" } } }, - "description": "OK" + "description": "Values for selected settings." } }, + "summary": "Values for all settings.", "tags": [ - "User management" - ] + "Workspaces - Settings", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } }, "post": { - "operationId": "managePermissionsForUserGroup", + "description": "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", + "operationId": "workspaceResolveSettings", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } + }, + { + "description": "If true, user-level settings are excluded from resolution.", + "in": "query", + "name": "excludeUserSettings", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/ResolveSettingsRequest" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "items": { + "$ref": "#/components/schemas/ResolvedSetting" + }, + "type": "array" + } + } + }, + "description": "Values for selected settings." } }, + "summary": "Values for selected settings.", "tags": [ - "User management" - ] + "Workspaces - Settings", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers": { + "/api/v1/actions/workspaces/{workspaceId}/setCertification": { "post": { - "operationId": "removeGroupMembers", + "description": "Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.", + "operationId": "setCertification", "parameters": [ { "in": "path", - "name": "userGroupId", + "name": "workspaceId", "required": true, "schema": { "type": "string" @@ -32352,7 +40850,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUserGroupMembers" + "$ref": "#/components/schemas/SetCertificationRequest" } } }, @@ -32364,84 +40862,31 @@ "description": "No Content" } }, + "summary": "Set Certification", "tags": [ - "User management" - ] + "actions", + "Certification" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/userManagement/users": { + "/api/v1/actions/workspaces/{workspaceId}/translations": { "get": { - "operationId": "listUsers", + "description": "Provides a list of effective translation tags.", + "operationId": "getTranslationTags", "parameters": [ { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", - "in": "query", - "name": "name", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by workspaceId.", - "example": "workspace=demo", - "in": "query", - "name": "workspace", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by userGroupId.", - "example": "group=admin", - "in": "query", - "name": "group", - "required": false, - "schema": { - "type": "string" - }, - "style": "form" - }, - { - "description": "Filter by dataSourceId.", - "example": "dataSource=demo-test-ds", - "in": "query", - "name": "dataSource", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { "type": "string" - }, - "style": "form" + } } ], "responses": { @@ -32449,65 +40894,129 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserManagementUsers" + "items": { + "type": "string" + }, + "type": "array" } } }, - "description": "OK" + "description": "Retrieved list of translation tags." } }, + "summary": "Get translation tags.", "tags": [ - "User management" - ] + "Translations", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/userManagement/users/{userId}/permissions": { - "get": { - "operationId": "listPermissionsForUser", + "/api/v1/actions/workspaces/{workspaceId}/translations/clean": { + "post": { + "description": "Cleans up all translations for a particular locale.", + "operationId": "cleanTranslations", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocaleRequest" + } + } }, + "required": true + }, + "responses": { + "204": { + "content": {}, + "description": "Translations were successfully removed." + } + }, + "summary": "Cleans up translations.", + "tags": [ + "Translations", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve": { + "post": { + "description": "Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.", + "operationId": "retrieveTranslations", + "parameters": [ { - "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", - "example": "includeInherited=true", - "in": "query", - "name": "includeInherited", - "required": false, + "in": "path", + "name": "workspaceId", + "required": true, "schema": { - "default": false, - "type": "boolean" - }, - "style": "form" + "type": "string" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LocaleRequest" + } + } + }, + "required": true + }, "responses": { "200": { "content": { - "application/json": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/Xliff" } } }, - "description": "OK" + "description": "XLIFF file containing translations for a particular locale." } }, + "summary": "Retrieve translations for entities.", "tags": [ - "User management" - ] - }, + "Translations", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/actions/workspaces/{workspaceId}/translations/set": { "post": { - "operationId": "managePermissionsForUser", + "description": "Set translation for existing entities in a particular locale.", + "operationId": "setTranslations", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" @@ -32516,9 +41025,9 @@ ], "requestBody": { "content": { - "application/json": { + "application/xml": { "schema": { - "$ref": "#/components/schemas/UserManagementPermissionAssignments" + "$ref": "#/components/schemas/Xliff" } } }, @@ -32527,18 +41036,26 @@ "responses": { "204": { "content": {}, - "description": "No Content" + "description": "Translations were successfully set." } }, + "summary": "Set translations for entities.", "tags": [ - "User management" - ] + "Translations", + "actions" + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { - "get": { - "description": "Returns a list of Users who created any object for this workspace", - "operationId": "createdBy", + "/api/v1/actions/workspaces/{workspaceId}/uploadNotification": { + "post": { + "description": "Notification sets up all reports to be computed again with new data.", + "operationId": "registerWorkspaceUploadNotification", "parameters": [ { "in": "path", @@ -32550,28 +41067,27 @@ } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" - } - } - }, - "description": "OK" + "204": { + "content": {}, + "description": "An upload notification has been successfully registered." } }, - "summary": "Get Analytics Catalog CreatedBy Users", + "summary": "Register an upload notification", "tags": [ - "Smart Functions", + "Invalidate Cache", "actions" - ] + ], + "x-gdc-security-info": { + "description": "Minimal permission required to use this endpoint.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { + "/api/v1/actions/workspaces/{workspaceId}/userGroups": { "get": { - "description": "Returns a list of tags for this workspace", - "operationId": "tags", + "operationId": "listWorkspaceUserGroups", "parameters": [ { "in": "path", @@ -32580,6 +41096,43 @@ "schema": { "type": "string" } + }, + { + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name. Note that user name is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" } ], "responses": { @@ -32587,23 +41140,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AnalyticsCatalogTags" + "$ref": "#/components/schemas/WorkspaceUserGroups" } } }, "description": "OK" } }, - "summary": "Get Analytics Catalog Tags", "tags": [ - "Smart Functions", + "User management", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { + "/api/v1/actions/workspaces/{workspaceId}/users": { "get": { - "operationId": "availableAssignees", + "operationId": "listWorkspaceUsers", "parameters": [ { "in": "path", @@ -32614,12 +41166,41 @@ } }, { - "in": "path", - "name": "dashboardId", - "required": true, + "description": "Zero-based page index (0..N)", + "example": "page=0", + "in": "query", + "name": "page", + "required": false, + "schema": { + "default": 0, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the page to be returned.", + "example": "size=20", + "in": "query", + "name": "size", + "required": false, + "schema": { + "default": 20, + "format": "int32", + "type": "integer" + }, + "style": "form" + }, + { + "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", + "example": "name=charles", + "in": "query", + "name": "name", + "required": false, "schema": { "type": "string" - } + }, + "style": "form" } ], "responses": { @@ -32627,23 +41208,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AvailableAssignees" + "$ref": "#/components/schemas/WorkspaceUsers" } } }, "description": "OK" } }, - "summary": "Get Available Assignees", "tags": [ - "Permissions", + "User management", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions": { + "/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/managePermissions": { "post": { - "operationId": "manageDashboardPermissions", + "operationId": "manageVisualizationPermissions", "parameters": [ { "in": "path", @@ -32655,7 +41235,7 @@ }, { "in": "path", - "name": "dashboardId", + "name": "visualizationObjectId", "required": true, "schema": { "type": "string" @@ -32666,14 +41246,14 @@ "content": { "application/json": { "schema": { - "description": "An array of dashboard permissions assignments", + "description": "An array of visualization-permission assignments.", "items": { "oneOf": [ { - "$ref": "#/components/schemas/PermissionsForAssignee" + "$ref": "#/components/schemas/VisualizationPermissionsForAssignee" }, { - "$ref": "#/components/schemas/PermissionsForAssigneeRule" + "$ref": "#/components/schemas/VisualizationPermissionsForAssigneeRule" } ] }, @@ -32689,16 +41269,16 @@ "description": "No Content" } }, - "summary": "Manage Permissions for a Dashboard", + "summary": "(BETA) Manage Permissions for a Visualization", "tags": [ "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions": { + "/api/v1/actions/workspaces/{workspaceId}/visualizationObjects/{visualizationObjectId}/permissions": { "get": { - "operationId": "dashboardPermissions", + "operationId": "visualizationPermissions", "parameters": [ { "in": "path", @@ -32710,7 +41290,7 @@ }, { "in": "path", - "name": "dashboardId", + "name": "visualizationObjectId", "required": true, "schema": { "type": "string" @@ -32722,123 +41302,127 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DashboardPermissions" + "$ref": "#/components/schemas/VisualizationPermissions" } } }, "description": "OK" } }, - "summary": "Get Dashboard Permissions", + "summary": "(BETA) Get Visualization Permissions", "tags": [ "Permissions", "actions" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions": { - "post": { - "operationId": "manageAttributePermissions", + "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { + "get": { + "operationId": "getEntity@CookieSecurityConfigurations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "path", - "name": "attributeId", - "required": true, + "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of attribute-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/AttributePermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/AttributePermissionsForAssigneeRule" - } - ] - }, - "type": "array" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Manage Permissions for an Attribute", + "summary": "Get CookieSecurityConfiguration", "tags": [ - "Permissions", - "actions" + "Cookie Security Configuration", + "entities", + "cookie-security-configuration-controller" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions": { - "get": { - "operationId": "attributePermissions", + }, + "patch": { + "operationId": "patchEntity@CookieSecurityConfigurations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "path", - "name": "attributeId", - "required": true, + "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AttributePermissions" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, - "summary": "Get Attribute Permissions", + "summary": "Patch CookieSecurityConfiguration", "tags": [ - "Permissions", - "actions" + "Cookie Security Configuration", + "entities", + "cookie-security-configuration-controller" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { - "post": { - "operationId": "deleteWorkspaceAutomations", + }, + "put": { + "operationId": "updateEntity@CookieSecurityConfigurations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -32848,259 +41432,538 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Delete selected automations in the workspace", + "summary": "Put CookieSecurityConfiguration", "tags": [ - "Automations", - "actions" + "Cookie Security Configuration", + "entities", + "cookie-security-configuration-controller" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { - "post": { - "operationId": "pauseWorkspaceAutomations", + "/api/v1/entities/admin/organizations/{id}": { + "get": { + "operationId": "getEntity@Organizations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "identityProviders", + "bootstrapUser", + "bootstrapUserGroup", + "identityProvider", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" - } - } - }, - "required": true - }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Pause selected automations in the workspace", + "summary": "Get Organizations", "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { - "post": { - "operationId": "unpauseWorkspaceAutomations", + "Organization - Entity APIs", + "entities", + "organization-entity-controller" + ], + "x-gdc-security-info": { + "description": "Contains permissions required to manipulate the Organization.", + "permissions": [ + "MANAGE" + ] + } + }, + "patch": { + "operationId": "patchEntity@Organizations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "identityProviders", + "bootstrapUser", + "bootstrapUserGroup", + "identityProvider", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Unpause selected automations in the workspace", + "summary": "Patch Organization", "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { - "delete": { - "operationId": "unsubscribeWorkspaceAutomations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } + "Organization - Entity APIs", + "entities", + "organization-entity-controller" ], - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Unsubscribe from all automations in the workspace", - "tags": [ - "Automations", - "actions" - ] + "x-gdc-security-info": { + "description": "Contains permissions required to manipulate the Organization.", + "permissions": [ + "MANAGE" + ] + } }, - "post": { - "operationId": "unsubscribeSelectedWorkspaceAutomations", + "put": { + "operationId": "updateEntity@Organizations", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "identityProviders", + "bootstrapUser", + "bootstrapUserGroup", + "identityProvider", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" + "$ref": "#/components/schemas/JsonApiOrganizationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationInDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Unsubscribe from selected automations in the workspace", + "summary": "Put Organization", "tags": [ - "Automations", - "actions" - ] + "Organization - Entity APIs", + "entities", + "organization-entity-controller" + ], + "x-gdc-security-info": { + "description": "Contains permissions required to manipulate the Organization.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { - "delete": { - "operationId": "unsubscribeAutomation", + "/api/v1/entities/agents": { + "get": { + "operationId": "getAllEntities@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "in": "path", - "name": "automationId", - "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": "createdBy,modifiedBy,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutList" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Unsubscribe from an automation", + "summary": "Get all Agent entities", "tags": [ - "Automations", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides": { + "Agents", + "entities", + "agent-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, "post": { - "description": "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", - "operationId": "checkEntityOverrides", + "description": "AI Agent - behavior configuration for AI assistants", + "operationId": "createEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "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": "createdBy,modifiedBy,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "An array of object identifications", - "items": { - "$ref": "#/components/schemas/HierarchyObjectIdentification" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiAgentInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentInDocument" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "Searching for entities finished successfully." + "description": "Request successfully processed" } }, - "summary": "Finds entities with given ID in hierarchy.", + "summary": "Post Agent entities", "tags": [ - "Hierarchy", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph": { + "/api/v1/entities/agents/{id}": { + "delete": { + "operationId": "deleteEntity@Agents", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Agent entity", + "tags": [ + "Agents", + "entities", + "agent-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "description": "Computes the dependent entities graph", - "operationId": "getDependentEntitiesGraph", + "operationId": "getEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "enabled==BooleanValue;name==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,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -33108,43 +41971,79 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DependentEntitiesResponse" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "Computes the dependent entities graph" + "description": "Request successfully processed" } }, - "summary": "Computes the dependent entities graph", + "summary": "Get Agent entity", "tags": [ - "Dependency Graph", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Permissions required to read the graph.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, - "post": { - "description": "Computes the dependent entities graph from given entry points", - "operationId": "getDependentEntitiesGraphFromEntryPoints", + "patch": { + "operationId": "patchEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "enabled==BooleanValue;name==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,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DependentEntitiesRequest" + "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentPatchDocument" } } }, @@ -33155,133 +42054,158 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DependentEntitiesResponse" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "Computes the dependent entities graph from given entry points" + "description": "Request successfully processed" } }, - "summary": "Computes the dependent entities graph from given entry points", + "summary": "Patch Agent entity", "tags": [ - "Dependency Graph", - "actions" + "Agents", + "entities", + "agent-controller" ], "x-gdc-security-info": { - "description": "Permissions required to read the graph.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions": { - "post": { - "operationId": "manageFactPermissions", + }, + "put": { + "operationId": "updateEntity@Agents", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "in": "path", - "name": "factId", - "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": "createdBy,modifiedBy,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "userIdentifiers", + "userGroups", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "description": "An array of fact-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/FactPermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/FactPermissionsForAssigneeRule" - } - ] - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiAgentInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentInDocument" } } }, "required": true }, - "responses": { - "204": { - "content": {}, - "description": "No Content" - } - }, - "summary": "Manage Permissions for a Fact", - "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions": { - "get": { - "operationId": "factPermissions", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "factId", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FactPermissions" + "$ref": "#/components/schemas/JsonApiAgentOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, - "summary": "Get Fact Permissions", + "summary": "Put Agent entity", "tags": [ - "Permissions", - "actions" - ] + "Agents", + "entities", + "agent-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts": { + "/api/v1/entities/colorPalettes": { "get": { - "description": "Finds API identifier conflicts in given workspace hierarchy.", - "operationId": "inheritedEntityConflicts", + "operationId": "getAllEntities@ColorPalettes", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "name==someString;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { "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": { @@ -33289,142 +42213,110 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiColorPaletteOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutList" } } }, - "description": "Searching for conflicting identifiers finished successfully" + "description": "Request successfully processed" } }, - "summary": "Finds identifier conflicts in workspace hierarchy.", + "summary": "Get all Color Pallettes", "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes": { - "get": { - "description": "Get used entity prefixes in hierarchy of parent workspaces", - "operationId": "inheritedEntityPrefixes", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" + "Appearance", + "entities", + "color-palette-controller" + ] + }, + "post": { + "operationId": "createEntity@ColorPalettes", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "Prefixes used in parent entities" + "description": "Request successfully processed" } }, - "summary": "Get used entity prefixes in hierarchy", + "summary": "Post Color Pallettes", "tags": [ - "Hierarchy", - "actions" + "Appearance", + "entities", + "color-palette-controller" ], "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "VIEW" + "MANAGE" ] } } }, - "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions": { - "post": { - "operationId": "manageLabelPermissions", + "/api/v1/entities/colorPalettes/{id}": { + "delete": { + "operationId": "deleteEntity@ColorPalettes", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "labelId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "An array of label-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/LabelPermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/LabelPermissionsForAssigneeRule" - } - ] - }, - "type": "array" - } - } - }, - "required": true - }, "responses": { "204": { - "content": {}, - "description": "No Content" + "$ref": "#/components/responses/Deleted" } }, - "summary": "Manage Permissions for a Label", + "summary": "Delete a Color Pallette", "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions": { + "Appearance", + "entities", + "color-palette-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "labelPermissions", + "operationId": "getEntity@ColorPalettes", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "path", - "name": "labelId", - "required": true, + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "name==someString;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -33435,29 +42327,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LabelPermissions" + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, - "summary": "Get Label Permissions", + "summary": "Get Color Pallette", "tags": [ - "Permissions", - "actions" + "Appearance", + "entities", + "color-palette-controller" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { - "post": { - "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", - "operationId": "manageWorkspacePermissions", + }, + "patch": { + "operationId": "patchEntity@ColorPalettes", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -33467,45 +42366,58 @@ "content": { "application/json": { "schema": { - "description": "An array of workspace permissions assignments", - "items": { - "$ref": "#/components/schemas/WorkspacePermissionAssignment" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Manage Permissions for a Workspace", + "summary": "Patch Color Pallette", "tags": [ - "Permissions", - "actions" - ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/managePermissions": { - "post": { - "operationId": "manageMetricPermissions", + "Appearance", + "entities", + "color-palette-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@ColorPalettes", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "in": "path", - "name": "metricId", - "required": true, + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "name==someString;content==JsonNodeValue", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -33515,55 +42427,92 @@ "content": { "application/json": { "schema": { - "description": "An array of metric-permission assignments.", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/MetricPermissionsForAssignee" - }, - { - "$ref": "#/components/schemas/MetricPermissionsForAssigneeRule" - } - ] - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "(BETA) Manage Permissions for a Metric", + "summary": "Put Color Pallette", "tags": [ - "Permissions", - "actions" - ] + "Appearance", + "entities", + "color-palette-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/actions/workspaces/{workspaceId}/metrics/{metricId}/permissions": { + "/api/v1/entities/cspDirectives": { "get": { - "operationId": "metricPermissions", + "description": " Context Security Police Directive", + "operationId": "getAllEntities@CspDirectives", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "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": "sources==v1,v2,v3", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "in": "path", - "name": "metricId", - "required": true, + "$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": { - "type": "string" - } + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -33571,83 +42520,103 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MetricPermissions" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" } } }, - "description": "OK" + "description": "Request successfully processed" } }, - "summary": "(BETA) Get Metric Permissions", + "summary": "Get CSP Directives", "tags": [ - "Permissions", - "actions" + "CSP Directives", + "entities", + "csp-directive-controller" ] - } - }, - "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities": { - "get": { - "description": "Finds API identifier overrides in given workspace hierarchy.", - "operationId": "overriddenChildEntities", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" + }, + "post": { + "description": " Context Security Police Directive", + "operationId": "createEntity@CspDirectives", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } } - } - ], + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/IdentifierDuplications" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Searching for overridden identifiers finished successfully" + "description": "Request successfully processed" } }, - "summary": "Finds identifier overrides in workspace hierarchy.", + "summary": "Post CSP Directives", "tags": [ - "Hierarchy", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "CSP Directives", + "entities", + "csp-directive-controller" + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/resolveSettings": { + "/api/v1/entities/cspDirectives/{id}": { + "delete": { + "description": " Context Security Police Directive", + "operationId": "deleteEntity@CspDirectives", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete CSP Directives", + "tags": [ + "CSP Directives", + "entities", + "csp-directive-controller" + ] + }, "get": { - "description": "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", - "operationId": "workspaceResolveAllSettings", + "description": " Context Security Police Directive", + "operationId": "getEntity@CspDirectives", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "description": "If true, user-level settings are excluded from resolution.", + "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": "sources==v1,v2,v3", "in": "query", - "name": "excludeUserSettings", - "required": false, + "name": "filter", "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], @@ -33656,48 +42625,39 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Values for selected settings." + "description": "Request successfully processed" } }, - "summary": "Values for all settings.", + "summary": "Get CSP Directives", "tags": [ - "Workspaces - Settings", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } + "CSP Directives", + "entities", + "csp-directive-controller" + ] }, - "post": { - "description": "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", - "operationId": "workspaceResolveSettings", + "patch": { + "description": " Context Security Police Directive", + "operationId": "patchEntity@CspDirectives", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } + "$ref": "#/components/parameters/idPathParameter" }, { - "description": "If true, user-level settings are excluded from resolution.", + "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": "sources==v1,v2,v3", "in": "query", - "name": "excludeUserSettings", - "required": false, + "name": "filter", "schema": { - "default": false, - "type": "boolean" + "type": "string" } } ], @@ -33705,7 +42665,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ResolveSettingsRequest" + "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" } } }, @@ -33716,38 +42681,37 @@ "content": { "application/json": { "schema": { - "items": { - "$ref": "#/components/schemas/ResolvedSetting" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, - "description": "Values for selected settings." + "description": "Request successfully processed" } }, - "summary": "Values for selected settings.", + "summary": "Patch CSP Directives", "tags": [ - "Workspaces - Settings", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/setCertification": { - "post": { - "description": "Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.", - "operationId": "setCertification", + "CSP Directives", + "entities", + "csp-directive-controller" + ] + }, + "put": { + "description": " Context Security Police Directive", + "operationId": "updateEntity@CspDirectives", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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": "sources==v1,v2,v3", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -33757,43 +42721,85 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SetCertificationRequest" + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "No Content" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Set Certification", + "summary": "Put CSP Directives", "tags": [ - "actions", - "Certification" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "CSP Directives", + "entities", + "csp-directive-controller" + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/translations": { + "/api/v1/entities/customGeoCollections": { "get": { - "description": "Provides a list of effective translation tags.", - "operationId": "getTranslationTags", + "operationId": "getAllEntities@CustomGeoCollections", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "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;description==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": { @@ -33801,130 +42807,138 @@ "content": { "application/json": { "schema": { - "items": { - "type": "string" - }, - "type": "array" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" } } }, - "description": "Retrieved list of translation tags." + "description": "Request successfully processed" } }, - "summary": "Get translation tags.", + "summary": "Get all Custom Geo Collections", "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/clean": { + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] + }, "post": { - "description": "Cleans up all translations for a particular locale.", - "operationId": "cleanTranslations", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], + "operationId": "createEntity@CustomGeoCollections", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LocaleRequest" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "Translations were successfully removed." + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Cleans up translations.", + "summary": "Post Custom Geo Collections", "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] } }, - "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve": { - "post": { - "description": "Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.", - "operationId": "retrieveTranslations", + "/api/v1/entities/customGeoCollections/{id}": { + "delete": { + "operationId": "deleteEntity@CustomGeoCollections", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Custom Geo Collection", + "tags": [ + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] + }, + "get": { + "operationId": "getEntity@CustomGeoCollections", + "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;description==someString", + "in": "query", + "name": "filter", "schema": { "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LocaleRequest" - } - } - }, - "required": true - }, "responses": { "200": { "content": { - "application/xml": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Xliff" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "XLIFF file containing translations for a particular locale." + "description": "Request successfully processed" } }, - "summary": "Retrieve translations for entities.", + "summary": "Get Custom Geo Collection", "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/translations/set": { - "post": { - "description": "Set translation for existing entities in a particular locale.", - "operationId": "setTranslations", + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] + }, + "patch": { + "operationId": "patchEntity@CustomGeoCollections", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "$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;description==someString", + "in": "query", + "name": "filter", "schema": { "type": "string" } @@ -33932,180 +42946,141 @@ ], "requestBody": { "content": { - "application/xml": { + "application/json": { "schema": { - "$ref": "#/components/schemas/Xliff" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" } } }, "required": true }, "responses": { - "204": { - "content": {}, - "description": "Translations were successfully set." - } - }, - "summary": "Set translations for entities.", - "tags": [ - "Translations", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/uploadNotification": { - "post": { - "description": "Notification sets up all reports to be computed again with new data.", - "operationId": "registerWorkspaceUploadNotification", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "content": {}, - "description": "An upload notification has been successfully registered." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Register an upload notification", + "summary": "Patch Custom Geo Collection", "tags": [ - "Invalidate Cache", - "actions" - ], - "x-gdc-security-info": { - "description": "Minimal permission required to use this endpoint.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/actions/workspaces/{workspaceId}/userGroups": { - "get": { - "operationId": "listWorkspaceUserGroups", + "Geographic Data", + "entities", + "custom-geo-collection-controller" + ] + }, + "put": { + "operationId": "updateEntity@CustomGeoCollections", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" - }, - { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" + "$ref": "#/components/parameters/idPathParameter" }, { - "description": "Filter by user name. Note that user name is case insensitive.", - "example": "name=charles", + "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;description==someString", "in": "query", - "name": "name", - "required": false, + "name": "filter", "schema": { "type": "string" - }, - "style": "form" + } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceUserGroups" + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, - "description": "OK" + "description": "Request successfully processed" } }, + "summary": "Put Custom Geo Collection", "tags": [ - "User management", - "actions" + "Geographic Data", + "entities", + "custom-geo-collection-controller" ] } }, - "/api/v1/actions/workspaces/{workspaceId}/users": { + "/api/v1/entities/dataSourceIdentifiers": { "get": { - "operationId": "listWorkspaceUsers", + "operationId": "getAllEntities@DataSourceIdentifiers", "parameters": [ { - "in": "path", - "name": "workspaceId", - "required": true, + "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;schema==someString", + "in": "query", + "name": "filter", "schema": { "type": "string" } }, { - "description": "Zero-based page index (0..N)", - "example": "page=0", - "in": "query", - "name": "page", - "required": false, - "schema": { - "default": 0, - "format": "int32", - "type": "integer" - }, - "style": "form" + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" }, { - "description": "The size of the page to be returned.", - "example": "size=20", - "in": "query", - "name": "size", - "required": false, - "schema": { - "default": 20, - "format": "int32", - "type": "integer" - }, - "style": "form" + "$ref": "#/components/parameters/sort" }, { - "description": "Filter by user name, email or login (user ID). Note that the filter is case insensitive.", - "example": "name=charles", + "description": "Include Meta objects.", + "example": "metaInclude=permissions,page,all", + "explode": false, "in": "query", - "name": "name", + "name": "metaInclude", "required": false, "schema": { - "type": "string" + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true }, "style": "form" } @@ -34115,34 +43090,69 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkspaceUsers" + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" } } }, - "description": "OK" + "description": "Request successfully processed" } }, + "summary": "Get all Data Source Identifiers", "tags": [ - "User management", - "actions" - ] + "Data Source - Entity APIs", + "entities", + "data-source-identifier-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to use this object type.", + "permissions": [ + "USE" + ] + } } }, - "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { + "/api/v1/entities/dataSourceIdentifiers/{id}": { "get": { - "operationId": "getEntity@CookieSecurityConfigurations", + "operationId": "getEntity@DataSourceIdentifiers", "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "example": "name==someString;schema==someString", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -34150,176 +43160,225 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get CookieSecurityConfiguration", + "summary": "Get Data Source Identifier", "tags": [ - "Cookie Security Configuration", + "Data Source - Entity APIs", "entities", - "cookie-security-configuration-controller" - ] - }, - "patch": { - "operationId": "patchEntity@CookieSecurityConfigurations", + "data-source-identifier-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to use this object type.", + "permissions": [ + "USE" + ] + } + } + }, + "/api/v1/entities/dataSources": { + "get": { + "description": "Data Source - represents data source for the workspace", + "operationId": "getAllEntities@DataSources", "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "example": "name==someString;type==DatabaseTypeValue", "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=permissions,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Patch CookieSecurityConfiguration", + "summary": "Get Data Source entities", "tags": [ - "Cookie Security Configuration", + "Data Source - Entity APIs", "entities", - "cookie-security-configuration-controller" - ] + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "MANAGE" + ] + } }, - "put": { - "operationId": "updateEntity@CookieSecurityConfigurations", + "post": { + "description": "Data Source - represents data source for the workspace", + "operationId": "createEntity@DataSources", "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": "lastRotation==InstantValue;rotationInterval==DurationValue", + "description": "Include Meta objects.", + "example": "metaInclude=permissions,all", + "explode": false, "in": "query", - "name": "filter", + "name": "metaInclude", + "required": false, "schema": { - "type": "string" - } + "description": "Included meta objects", + "items": { + "enum": [ + "permissions", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put CookieSecurityConfiguration", + "summary": "Post Data Sources", "tags": [ - "Cookie Security Configuration", + "Data Source - Entity APIs", "entities", - "cookie-security-configuration-controller" - ] + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/admin/organizations/{id}": { + "/api/v1/entities/dataSources/{id}": { + "delete": { + "description": "Data Source - represents data source for the workspace", + "operationId": "deleteEntity@DataSources", + "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete Data Source entity", + "tags": [ + "Data Source - Entity APIs", + "entities", + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Organizations", + "description": "Data Source - represents data source for the workspace", + "operationId": "getEntity@DataSources", "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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "example": "name==someString;type==DatabaseTypeValue", "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": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,all", @@ -34348,81 +43407,58 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Organizations", + "summary": "Get Data Source entity", "tags": [ - "Organization - Entity APIs", + "Data Source - Entity APIs", "entities", - "organization-entity-controller" + "data-source-controller" ], "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } }, "patch": { - "operationId": "patchEntity@Organizations", + "description": "Data Source - represents data source for the workspace", + "operationId": "patchEntity@DataSources", "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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "example": "name==someString;type==DatabaseTypeValue", "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": "bootstrapUser,bootstrapUserGroup,identityProvider", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" + "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" + "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" } } }, @@ -34433,40 +43469,102 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Organization", + "summary": "Patch Data Source entity", "tags": [ - "Organization - Entity APIs", + "Data Source - Entity APIs", "entities", - "organization-entity-controller" + "data-source-controller" ], "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { - "operationId": "updateEntity@Organizations", + "description": "Data Source - represents data source for the workspace", + "operationId": "updateEntity@DataSources", "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;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", + "example": "name==someString;type==DatabaseTypeValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put Data Source entity", + "tags": [ + "Data Source - Entity APIs", + "entities", + "data-source-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/entitlements": { + "get": { + "description": "Space of the shared interest", + "operationId": "getAllEntities@Entitlements", + "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": "value==someString;expiry==LocalDateValue", "in": "query", "name": "filter", "schema": { @@ -34474,111 +43572,130 @@ } }, { - "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": "bootstrapUser,bootstrapUserGroup,identityProvider", + "$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": "include", + "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { "enum": [ - "users", - "userGroups", - "identityProviders", - "bootstrapUser", - "bootstrapUserGroup", - "identityProvider", + "page", + "all", "ALL" ], "type": "string" }, - "type": "array" + "type": "array", + "uniqueItems": true }, "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationInDocument" + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiEntitlementOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiEntitlementOutList" + } } }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationInDocument" - } - } - }, - "required": true + "description": "Request successfully processed" + } }, + "summary": "Get Entitlements", + "tags": [ + "Entitlement", + "entities", + "entitlement-entity-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/entitlements/{id}": { + "get": { + "description": "Space of the shared interest", + "operationId": "getEntity@Entitlements", + "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": "value==someString;expiry==LocalDateValue", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" + "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Organization", + "summary": "Get Entitlement entity", "tags": [ - "Organization - Entity APIs", + "Entitlement", "entities", - "organization-entity-controller" + "entitlement-entity-controller" ], "x-gdc-security-info": { - "description": "Contains permissions required to manipulate the Organization.", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/agents": { + "/api/v1/entities/exportTemplates": { "get": { - "operationId": "getAllEntities@Agents", + "operationId": "getAllEntities@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -34616,68 +43733,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutList" + "$ref": "#/components/schemas/JsonApiExportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutList" + "$ref": "#/components/schemas/JsonApiExportTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Agent entities", + "summary": "GET all Export Template entities", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "export-template-controller" + ] }, "post": { - "description": "AI Agent - behavior configuration for AI assistants", - "operationId": "createEntity@Agents", - "parameters": [ - { - "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], + "operationId": "createEntity@ExportTemplates", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } } }, @@ -34688,23 +43774,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Agent entities", + "summary": "Post Export Template entities", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34714,9 +43800,9 @@ } } }, - "/api/v1/entities/agents/{id}": { + "/api/v1/entities/exportTemplates/{id}": { "delete": { - "operationId": "deleteEntity@Agents", + "operationId": "deleteEntity@ExportTemplates", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -34727,11 +43813,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Agent entity", + "summary": "Delete Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34741,41 +43827,19 @@ } }, "get": { - "operationId": "getEntity@Agents", + "operationId": "getEntity@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "responses": { @@ -34783,79 +43847,51 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Agent entity", + "summary": "GET Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } + "export-template-controller" + ] }, "patch": { - "operationId": "patchEntity@Agents", + "operationId": "patchEntity@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentPatchDocument" + "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" } } }, @@ -34866,23 +43902,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Agent entity", + "summary": "Patch Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34892,53 +43928,31 @@ } }, "put": { - "operationId": "updateEntity@Agents", + "operationId": "updateEntity@ExportTemplates", "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": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", + "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "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,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "userIdentifiers", - "userGroups", - "createdBy", - "modifiedBy", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentInDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" } } }, @@ -34949,23 +43963,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAgentOutDocument" + "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Agent entity", + "summary": "PUT Export Template entity", "tags": [ - "AI Agents", + "Export templates", "entities", - "agent-controller" + "export-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -34975,13 +43989,13 @@ } } }, - "/api/v1/entities/colorPalettes": { + "/api/v1/entities/identityProviders": { "get": { - "operationId": "getAllEntities@ColorPalettes", + "operationId": "getAllEntities@IdentityProviders", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -35025,37 +44039,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutList" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutList" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Color Pallettes", + "summary": "Get all Identity Providers", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" - ] + "identity-provider-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "post": { - "operationId": "createEntity@ColorPalettes", + "operationId": "createEntity@IdentityProviders", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, @@ -35066,23 +44086,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Color Pallettes", + "summary": "Post Identity Providers", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35092,9 +44112,9 @@ } } }, - "/api/v1/entities/colorPalettes/{id}": { + "/api/v1/entities/identityProviders/{id}": { "delete": { - "operationId": "deleteEntity@ColorPalettes", + "operationId": "deleteEntity@IdentityProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -35105,11 +44125,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Color Pallette", + "summary": "Delete Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35119,14 +44139,14 @@ } }, "get": { - "operationId": "getEntity@ColorPalettes", + "operationId": "getEntity@IdentityProviders", "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;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -35139,34 +44159,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Color Pallette", + "summary": "Get Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" - ] + "identity-provider-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "operationId": "patchEntity@ColorPalettes", + "operationId": "patchEntity@IdentityProviders", "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;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -35178,12 +44204,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" } } }, @@ -35194,23 +44220,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Color Pallette", + "summary": "Patch Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35220,14 +44246,14 @@ } }, "put": { - "operationId": "updateEntity@ColorPalettes", + "operationId": "updateEntity@IdentityProviders", "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;content==JsonNodeValue", + "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { @@ -35239,12 +44265,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, @@ -35255,23 +44281,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" + "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Color Pallette", + "summary": "Put Identity Provider", "tags": [ - "Appearance", + "Identity Providers", "entities", - "color-palette-controller" + "identity-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -35281,20 +44307,39 @@ } } }, - "/api/v1/entities/cspDirectives": { + "/api/v1/entities/ipAllowlistPolicies": { "get": { - "description": " Context Security Police Directive", - "operationId": "getAllEntities@CspDirectives", + "operationId": "getAllEntities@IpAllowlistPolicies", "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": "sources==v1,v2,v3", + "example": "allowedSources==v1,v2,v3", "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": "users,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -35332,38 +44377,65 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get CSP Directives", + "summary": "Get all IpAllowlistPolicy entities", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "post": { - "description": " Context Security Police Directive", - "operationId": "createEntity@CspDirectives", + "operationId": "createEntity@IpAllowlistPolicies", + "parameters": [ + { + "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": "users,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } } }, @@ -35374,30 +44446,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post CSP Directives", + "summary": "Post IpAllowlistPolicy entities", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/cspDirectives/{id}": { + "/api/v1/entities/ipAllowlistPolicies/{id}": { "delete": { - "description": " Context Security Police Directive", - "operationId": "deleteEntity@CspDirectives", + "operationId": "deleteEntity@IpAllowlistPolicies", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -35408,137 +44485,131 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete CSP Directives", + "summary": "Delete IpAllowlistPolicy entity", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "get": { - "description": " Context Security Police Directive", - "operationId": "getEntity@CspDirectives", + "operationId": "getEntity@IpAllowlistPolicies", "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": "sources==v1,v2,v3", + "example": "allowedSources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get CSP Directives", - "tags": [ - "CSP Directives", - "entities", - "csp-directive-controller" - ] - }, - "patch": { - "description": " Context Security Police Directive", - "operationId": "patchEntity@CspDirectives", - "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": "sources==v1,v2,v3", + "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": "users,userGroups", + "explode": false, "in": "query", - "name": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch CSP Directives", + "summary": "Get IpAllowlistPolicy entity", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, "put": { - "description": " Context Security Police Directive", - "operationId": "updateEntity@CspDirectives", + "operationId": "updateEntity@IpAllowlistPolicies", "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": "sources==v1,v2,v3", + "example": "allowedSources==v1,v2,v3", "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": "users,userGroups", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "users", + "userGroups", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } } }, @@ -35549,33 +44620,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" + "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put CSP Directives", + "summary": "Put IpAllowlistPolicy entity", "tags": [ - "CSP Directives", + "Organization - Entity APIs", "entities", - "csp-directive-controller" - ] + "ip-allowlist-policy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/customGeoCollections": { + "/api/v1/entities/jwks": { "get": { - "operationId": "getAllEntities@CustomGeoCollections", + "description": "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", + "operationId": "getAllEntities@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -35619,37 +44697,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + "$ref": "#/components/schemas/JsonApiJwkOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" + "$ref": "#/components/schemas/JsonApiJwkOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Custom Geo Collections", + "summary": "Get all Jwks", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" + "jwk-controller" ] }, "post": { - "operationId": "createEntity@CustomGeoCollections", + "description": "Creates JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "createEntity@Jwks", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } } }, @@ -35660,29 +44739,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Custom Geo Collections", + "summary": "Post Jwks", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/customGeoCollections/{id}": { + "/api/v1/entities/jwks/{id}": { "delete": { - "operationId": "deleteEntity@CustomGeoCollections", + "description": "Deletes JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "deleteEntity@Jwks", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -35693,22 +44779,29 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Custom Geo Collection", + "summary": "Delete Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "get": { - "operationId": "getEntity@CustomGeoCollections", + "description": "Returns JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "getEntity@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -35721,34 +44814,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Custom Geo Collection", + "summary": "Get Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" + "jwk-controller" ] }, "patch": { - "operationId": "patchEntity@CustomGeoCollections", + "description": "Patches JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "patchEntity@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -35760,12 +44854,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + "$ref": "#/components/schemas/JsonApiJwkPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" + "$ref": "#/components/schemas/JsonApiJwkPatchDocument" } } }, @@ -35776,34 +44870,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Custom Geo Collection", + "summary": "Patch Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "put": { - "operationId": "updateEntity@CustomGeoCollections", + "description": "Updates JSON web key - used to verify JSON web tokens (Jwts)", + "operationId": "updateEntity@Jwks", "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;description==someString", + "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { @@ -35815,12 +44916,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" + "$ref": "#/components/schemas/JsonApiJwkInDocument" } } }, @@ -35831,181 +44932,173 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" + "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Custom Geo Collection", + "summary": "Put Jwk", "tags": [ - "Geographic Data", + "JWKS", "entities", - "custom-geo-collection-controller" - ] + "jwk-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/dataSourceIdentifiers": { + "/api/v1/entities/llmEndpoints": { "get": { - "operationId": "getAllEntities@DataSourceIdentifiers", + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "getAllEntities", + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "Get all LLM endpoint entities (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] + }, + "post": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "createEntity", + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "Post LLM endpoint entities (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] + } + }, + "/api/v1/entities/llmEndpoints/{id}": { + "delete": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "deleteEntity", "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;schema==someString", - "in": "query", - "name": "filter", + "in": "path", + "name": "id", + "required": true, "schema": { "type": "string" } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" - } - } - }, - "description": "Request successfully processed" + "410": { + "description": "Gone" } }, - "summary": "Get all Data Source Identifiers", + "summary": "Delete LLM endpoint entity (Removed)", "tags": [ - "Data Source - Entity APIs", - "entities", - "data-source-identifier-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to use this object type.", - "permissions": [ - "USE" - ] - } - } - }, - "/api/v1/entities/dataSourceIdentifiers/{id}": { + "LLM Endpoints", + "entities" + ] + }, "get": { - "operationId": "getEntity@DataSourceIdentifiers", + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "getEntity", "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;schema==someString", - "in": "query", - "name": "filter", + "in": "path", + "name": "id", + "required": true, "schema": { "type": "string" } - }, + } + ], + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "Get LLM endpoint entity (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] + }, + "patch": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "patchEntity", + "parameters": [ { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, + "in": "path", + "name": "id", + "required": true, "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "type": "string" + } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" + "410": { + "description": "Gone" } }, - "summary": "Get Data Source Identifier", + "summary": "Patch LLM endpoint entity (Removed)", "tags": [ - "Data Source - Entity APIs", - "entities", - "data-source-identifier-controller" + "LLM Endpoints", + "entities" + ] + }, + "put": { + "deprecated": true, + "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", + "operationId": "updateEntity", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { + "type": "string" + } + } ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to use this object type.", - "permissions": [ - "USE" - ] - } + "responses": { + "410": { + "description": "Gone" + } + }, + "summary": "PUT LLM endpoint entity (Removed)", + "tags": [ + "LLM Endpoints", + "entities" + ] } }, - "/api/v1/entities/dataSources": { + "/api/v1/entities/llmProviders": { "get": { - "description": "Data Source - represents data source for the workspace", - "operationId": "getAllEntities@DataSources", + "operationId": "getAllEntities@LlmProviders", "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;type==DatabaseTypeValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36023,7 +45116,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,page,all", + "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -36032,7 +45125,6 @@ "description": "Included meta objects", "items": { "enum": [ - "permissions", "page", "all", "ALL" @@ -36050,68 +45142,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutList" + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutList" + "$ref": "#/components/schemas/JsonApiLlmProviderOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Data Source entities", + "summary": "Get all LLM Provider entities", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "llm-provider-controller" + ] }, "post": { - "description": "Data Source - represents data source for the workspace", - "operationId": "createEntity@DataSources", - "parameters": [ - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], + "description": "LLM Provider - connection configuration for LLM services", + "operationId": "createEntity@LlmProviders", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } } }, @@ -36122,23 +45184,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Data Sources", + "summary": "Post LLM Provider entities", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36148,10 +45210,9 @@ } } }, - "/api/v1/entities/dataSources/{id}": { + "/api/v1/entities/llmProviders/{id}": { "delete": { - "description": "Data Source - represents data source for the workspace", - "operationId": "deleteEntity@DataSources", + "operationId": "deleteEntity@LlmProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -36162,11 +45223,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Data Source entity", + "summary": "Delete LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36176,42 +45237,19 @@ } }, "get": { - "description": "Data Source - represents data source for the workspace", - "operationId": "getEntity@DataSources", + "operationId": "getEntity@LlmProviders", "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;type==DatabaseTypeValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=permissions,all", - "explode": 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": "name==someString;description==someString", "in": "query", - "name": "metaInclude", - "required": false, + "name": "filter", "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "permissions", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" + "type": "string" + } } ], "responses": { @@ -36219,41 +45257,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Data Source entity", + "summary": "Get LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "llm-provider-controller" + ] }, "patch": { - "description": "Data Source - represents data source for the workspace", - "operationId": "patchEntity@DataSources", + "operationId": "patchEntity@LlmProviders", "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;type==DatabaseTypeValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36265,12 +45296,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" } } }, @@ -36281,23 +45312,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Data Source entity", + "summary": "Patch LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36307,15 +45338,14 @@ } }, "put": { - "description": "Data Source - represents data source for the workspace", - "operationId": "updateEntity@DataSources", + "operationId": "updateEntity@LlmProviders", "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;type==DatabaseTypeValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36327,12 +45357,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceInDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } } }, @@ -36343,23 +45373,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" + "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Data Source entity", + "summary": "PUT LLM Provider entity", "tags": [ - "Data Source - Entity APIs", + "LLM Providers", "entities", - "data-source-controller" + "llm-provider-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36369,14 +45399,13 @@ } } }, - "/api/v1/entities/entitlements": { + "/api/v1/entities/notificationChannelIdentifiers": { "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Entitlements", + "operationId": "getAllEntities@NotificationChannelIdentifiers", "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": "value==someString;expiry==LocalDateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36420,43 +45449,36 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Entitlements", + "summary": "Get all Notification Channel Identifier entities", "tags": [ - "Entitlement", + "Notification Channels", "entities", - "entitlement-entity-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "notification-channel-identifier-controller" + ] } }, - "/api/v1/entities/entitlements/{id}": { + "/api/v1/entities/notificationChannelIdentifiers/{id}": { "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Entitlements", + "operationId": "getEntity@NotificationChannelIdentifiers", "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": "value==someString;expiry==LocalDateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36469,39 +45491,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Entitlement entity", + "summary": "Get Notification Channel Identifier entity", "tags": [ - "Entitlement", + "Notification Channels", "entities", - "entitlement-entity-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "notification-channel-identifier-controller" + ] } }, - "/api/v1/entities/exportTemplates": { + "/api/v1/entities/notificationChannels": { "get": { - "operationId": "getAllEntities@ExportTemplates", + "operationId": "getAllEntities@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36545,37 +45561,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutList" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" } } }, "description": "Request successfully processed" } }, - "summary": "GET all Export Template entities", + "summary": "Get all Notification Channel entities", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ] }, "post": { - "operationId": "createEntity@ExportTemplates", + "operationId": "createEntity@NotificationChannels", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } } }, @@ -36586,23 +45602,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Export Template entities", + "summary": "Post Notification Channel entities", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36612,9 +45628,9 @@ } } }, - "/api/v1/entities/exportTemplates/{id}": { + "/api/v1/entities/notificationChannels/{id}": { "delete": { - "operationId": "deleteEntity@ExportTemplates", + "operationId": "deleteEntity@NotificationChannels", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -36625,11 +45641,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Export Template entity", + "summary": "Delete Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36639,14 +45655,14 @@ } }, "get": { - "operationId": "getEntity@ExportTemplates", + "operationId": "getEntity@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36659,34 +45675,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "GET Export Template entity", + "summary": "Get Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ] }, "patch": { - "operationId": "patchEntity@ExportTemplates", + "operationId": "patchEntity@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36698,12 +45714,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" } } }, @@ -36714,23 +45730,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Export Template entity", + "summary": "Patch Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36740,14 +45756,14 @@ } }, "put": { - "operationId": "updateEntity@ExportTemplates", + "operationId": "updateEntity@NotificationChannels", "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;dashboardSlidesTemplate==DashboardSlidesTemplateValue", + "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -36759,12 +45775,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" } } }, @@ -36775,23 +45791,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" + "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "PUT Export Template entity", + "summary": "Put Notification Channel entity", "tags": [ - "Export templates", + "Notification Channels", "entities", - "export-template-controller" + "notification-channel-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -36801,19 +45817,40 @@ } } }, - "/api/v1/entities/identityProviders": { + "/api/v1/entities/orgMemoryItems": { "get": { - "operationId": "getAllEntities@IdentityProviders", + "operationId": "getAllEntities@OrgMemoryItems", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -36851,204 +45888,94 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Identity Providers", + "summary": "Get all organization Memory Item entities", "tags": [ - "Identity Providers", + "Memory Items", "entities", - "identity-provider-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "post": { - "operationId": "createEntity@IdentityProviders", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Identity Providers", - "tags": [ - "Identity Providers", - "entities", - "identity-provider-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/identityProviders/{id}": { - "delete": { - "operationId": "deleteEntity@IdentityProviders", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "identity-provider-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "get": { - "operationId": "getEntity@IdentityProviders", + "description": "Organization-scoped AI memory item", + "operationId": "createEntity@OrgMemoryItems", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", + "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": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } + "type": "array" }, - "description": "Request successfully processed" - } - }, - "summary": "Get Identity Provider", - "tags": [ - "Identity Providers", - "entities", - "identity-provider-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "operationId": "patchEntity@IdentityProviders", - "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": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, "required": true }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Identity Provider", + "summary": "Post organization Memory Item entities", "tags": [ - "Identity Providers", + "Memory Items", "entities", - "identity-provider-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -37056,60 +45983,26 @@ "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@IdentityProviders", + } + }, + "/api/v1/entities/orgMemoryItems/{id}": { + "delete": { + "operationId": "deleteEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" - } - } - }, - "required": true - }, "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" - } - } - }, - "description": "Request successfully processed" + "204": { + "$ref": "#/components/responses/Deleted" } }, - "summary": "Put Identity Provider", + "summary": "Delete an organization Memory Item entity", "tags": [ - "Identity Providers", + "Memory Items", "entities", - "identity-provider-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -37117,69 +46010,40 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/ipAllowlistPolicies": { + }, "get": { - "operationId": "getAllEntities@IpAllowlistPolicies", + "operationId": "getEntity@OrgMemoryItems", "parameters": [ { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "allowedSources==v1,v2,v3", - "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": "users,userGroups", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "users", - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "$ref": "#/components/parameters/idPathParameter" }, { - "$ref": "#/components/parameters/sort" + "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": "Include Meta objects.", - "example": "metaInclude=page,all", + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } @@ -37189,23 +46053,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all IpAllowlistPolicy entities", + "summary": "Get an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "Memory Items", "entities", - "ip-allowlist-policy-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -37214,12 +46078,24 @@ ] } }, - "post": { - "operationId": "createEntity@IpAllowlistPolicies", + "patch": { + "operationId": "patchEntity@OrgMemoryItems", "parameters": [ + { + "$ref": "#/components/parameters/idPathParameter" + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "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": "users,userGroups", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -37227,8 +46103,9 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -37242,66 +46119,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post IpAllowlistPolicy entities", - "tags": [ - "Organization - Entity APIs", - "entities", - "ip-allowlist-policy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/ipAllowlistPolicies/{id}": { - "delete": { - "operationId": "deleteEntity@IpAllowlistPolicies", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete IpAllowlistPolicy entity", + "summary": "Patch an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "Memory Items", "entities", - "ip-allowlist-policy-controller" + "org-memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -37310,15 +46160,15 @@ ] } }, - "get": { - "operationId": "getEntity@IpAllowlistPolicies", + "put": { + "operationId": "updateEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "allowedSources==v1,v2,v3", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -37327,7 +46177,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": "users,userGroups", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -37335,8 +46185,9 @@ "schema": { "items": { "enum": [ - "users", - "userGroups", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -37346,45 +46197,96 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get IpAllowlistPolicy entity", + "summary": "Put an organization Memory Item entity", "tags": [ - "Organization - Entity APIs", + "Memory Items", "entities", - "ip-allowlist-policy-controller" + "org-memory-item-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" ] } - }, - "put": { - "operationId": "updateEntity@IpAllowlistPolicies", + } + }, + "/api/v1/entities/organization": { + "get": { + "description": "Gets a basic information about organization.", + "operationId": "getOrganization", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" - }, + "description": "Return list of permissions available to logged user.", + "example": "metaInclude=permissions", + "explode": false, + "in": "query", + "name": "metaInclude", + "schema": { + "items": { + "description": "Available meta objects to include.", + "enum": [ + "permissions", + "all" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "302": { + "description": "Redirect to entity URI." + } + }, + "summary": "Get current organization info", + "tags": [ + "Organization - Entity APIs", + "entities" + ] + } + }, + "/api/v1/entities/organization/workspaceAutomations": { + "get": { + "operationId": "getAllAutomations@WorkspaceAutomations", + "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "allowedSources==v1,v2,v3", + "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", "in": "query", "name": "filter", "schema": { @@ -37393,7 +46295,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": "users,userGroups", + "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", @@ -37401,8 +46303,19 @@ "schema": { "items": { "enum": [ + "workspaces", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", "users", - "userGroups", + "automationResults", + "workspace", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -37410,62 +46323,77 @@ "type": "array" }, "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put IpAllowlistPolicy entity", + "summary": "Get all Automations across all Workspaces", "tags": [ - "Organization - Entity APIs", + "Automations", "entities", - "ip-allowlist-policy-controller" + "automation-organization-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } } }, - "/api/v1/entities/jwks": { + "/api/v1/entities/organizationSettings": { "get": { - "description": "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", - "operationId": "getAllEntities@Jwks", + "operationId": "getAllEntities@OrganizationSettings", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -37509,38 +46437,43 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutList" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutList" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Jwks", + "summary": "Get Organization Setting entities", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" - ] + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "post": { - "description": "Creates JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "createEntity@Jwks", + "operationId": "createEntity@OrganizationSettings", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, @@ -37551,23 +46484,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Jwks", + "summary": "Post Organization Setting entities", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" + "organization-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -37577,10 +46510,9 @@ } } }, - "/api/v1/entities/jwks/{id}": { + "/api/v1/entities/organizationSettings/{id}": { "delete": { - "description": "Deletes JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "deleteEntity@Jwks", + "operationId": "deleteEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -37591,11 +46523,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Jwk", + "summary": "Delete Organization Setting entity", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" + "organization-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -37605,15 +46537,14 @@ } }, "get": { - "description": "Returns JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "getEntity@Jwks", + "operationId": "getEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -37626,35 +46557,40 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Jwk", + "summary": "Get Organization Setting entity", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" - ] + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "description": "Patches JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "patchEntity@Jwks", + "operationId": "patchEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -37666,12 +46602,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkPatchDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkPatchDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } } }, @@ -37682,23 +46618,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Jwk", + "summary": "Patch Organization Setting entity", "tags": [ - "JWKS", + "Organization - Entity APIs", "entities", - "jwk-controller" + "organization-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -37708,15 +46644,14 @@ } }, "put": { - "description": "Updates JSON web key - used to verify JSON web tokens (Jwts)", - "operationId": "updateEntity@Jwks", + "operationId": "updateEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JwkSpecificationValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -37728,12 +46663,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkInDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, @@ -37744,173 +46679,39 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiJwkOutDocument" + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Jwk", - "tags": [ - "JWKS", - "entities", - "jwk-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - } - }, - "/api/v1/entities/llmEndpoints": { - "get": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "getAllEntities", - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Get all LLM endpoint entities (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "post": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "createEntity", - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Post LLM endpoint entities (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - } - }, - "/api/v1/entities/llmEndpoints/{id}": { - "delete": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "deleteEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Delete LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "get": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "getEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Get LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "patch": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "patchEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "Patch LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] - }, - "put": { - "deprecated": true, - "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", - "operationId": "updateEntity", - "parameters": [ - { - "in": "path", - "name": "id", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "410": { - "description": "Gone" - } - }, - "summary": "PUT LLM endpoint entity (Removed)", - "tags": [ - "LLM Endpoints", - "entities" - ] + "summary": "Put Organization Setting entity", + "tags": [ + "Organization - Entity APIs", + "entities", + "organization-setting-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/llmProviders": { + "/api/v1/entities/themes": { "get": { - "operationId": "getAllEntities@LlmProviders", + "operationId": "getAllEntities@Themes", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "name==someString;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -37954,38 +46755,37 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + "$ref": "#/components/schemas/JsonApiThemeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutList" + "$ref": "#/components/schemas/JsonApiThemeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all LLM Provider entities", + "summary": "Get all Theming entities", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ] }, "post": { - "description": "LLM Provider - connection configuration for LLM services", - "operationId": "createEntity@LlmProviders", + "operationId": "createEntity@Themes", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } } }, @@ -37996,23 +46796,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post LLM Provider entities", + "summary": "Post Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38022,9 +46822,9 @@ } } }, - "/api/v1/entities/llmProviders/{id}": { + "/api/v1/entities/themes/{id}": { "delete": { - "operationId": "deleteEntity@LlmProviders", + "operationId": "deleteEntity@Themes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -38035,11 +46835,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete LLM Provider entity", + "summary": "Delete Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38049,14 +46849,14 @@ } }, "get": { - "operationId": "getEntity@LlmProviders", + "operationId": "getEntity@Themes", "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;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -38069,34 +46869,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get LLM Provider entity", + "summary": "Get Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ] }, "patch": { - "operationId": "patchEntity@LlmProviders", + "operationId": "patchEntity@Themes", "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;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -38108,12 +46908,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiThemePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" + "$ref": "#/components/schemas/JsonApiThemePatchDocument" } } }, @@ -38124,23 +46924,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch LLM Provider entity", + "summary": "Patch Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38150,14 +46950,14 @@ } }, "put": { - "operationId": "updateEntity@LlmProviders", + "operationId": "updateEntity@Themes", "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;description==someString", + "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -38169,12 +46969,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" + "$ref": "#/components/schemas/JsonApiThemeInDocument" } } }, @@ -38185,23 +46985,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" + "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "PUT LLM Provider entity", + "summary": "Put Theming", "tags": [ - "LLM Providers", + "Appearance", "entities", - "llm-provider-controller" + "theme-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38211,19 +47011,40 @@ } } }, - "/api/v1/entities/notificationChannelIdentifiers": { + "/api/v1/entities/userGroups": { "get": { - "operationId": "getAllEntities@NotificationChannelIdentifiers", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "getAllEntities@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -38261,149 +47082,66 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + "$ref": "#/components/schemas/JsonApiUserGroupOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" + "$ref": "#/components/schemas/JsonApiUserGroupOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Notification Channel Identifier entities", + "summary": "Get UserGroup entities", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-identifier-controller" - ] - } - }, - "/api/v1/entities/notificationChannelIdentifiers/{id}": { - "get": { - "operationId": "getEntity@NotificationChannelIdentifiers", - "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;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - } + "user-group-controller" ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Notification Channel Identifier entity", - "tags": [ - "Notification Channels", - "entities", - "notification-channel-identifier-controller" - ] - } - }, - "/api/v1/entities/notificationChannels": { - "get": { - "operationId": "getAllEntities@NotificationChannels", + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "post": { + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "createEntity@UserGroups", "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;description==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", + "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": "parents", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "userGroups", + "parents", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Notification Channel entities", - "tags": [ - "Notification Channels", - "entities", - "notification-channel-controller" - ] - }, - "post": { - "operationId": "createEntity@NotificationChannels", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } } }, @@ -38414,23 +47152,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Notification Channel entities", + "summary": "Post User Group entities", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" + "user-group-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38440,9 +47178,10 @@ } } }, - "/api/v1/entities/notificationChannels/{id}": { + "/api/v1/entities/userGroups/{id}": { "delete": { - "operationId": "deleteEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "deleteEntity@UserGroups", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -38453,11 +47192,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Notification Channel entity", + "summary": "Delete UserGroup entity", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" + "user-group-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38467,19 +47206,40 @@ } }, "get": { - "operationId": "getEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "getEntity@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "responses": { @@ -38487,51 +47247,78 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Notification Channel entity", + "summary": "Get UserGroup entity", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" - ] + "user-group-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } }, "patch": { - "operationId": "patchEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "patchEntity@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" + "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" + "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" } } }, @@ -38542,23 +47329,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Notification Channel entity", + "summary": "Patch UserGroup entity", "tags": [ - "Notification Channels", + "UserGroups - Entity APIs", "entities", - "notification-channel-controller" + "user-group-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38568,31 +47355,52 @@ } }, "put": { - "operationId": "updateEntity@NotificationChannels", + "description": "User Group - creates tree-like structure for categorizing users", + "operationId": "updateEntity@UserGroups", "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;description==someString", + "example": "name==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": "parents", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userGroups", + "parents", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" + "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } } }, @@ -38603,39 +47411,154 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put UserGroup entity", + "tags": [ + "UserGroups - Entity APIs", + "entities", + "user-group-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + } + }, + "/api/v1/entities/userIdentifiers": { + "get": { + "description": "UserIdentifier - represents entity interacting with platform", + "operationId": "getAllEntities@UserIdentifiers", + "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": "firstname==someString;lastname==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/JsonApiUserIdentifierOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get UserIdentifier entities", + "tags": [ + "User Identifiers", + "entities", + "user-identifier-controller" + ] + } + }, + "/api/v1/entities/userIdentifiers/{id}": { + "get": { + "description": "UserIdentifier - represents basic information about entity interacting with platform", + "operationId": "getEntity@UserIdentifiers", + "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": "firstname==someString;lastname==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" + "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Notification Channel entity", + "summary": "Get UserIdentifier entity", "tags": [ - "Notification Channels", + "User Identifiers", "entities", - "notification-channel-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-identifier-controller" + ] } }, - "/api/v1/entities/orgMemoryItems": { + "/api/v1/entities/users": { "get": { - "operationId": "getAllEntities@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "getAllEntities@Users", "parameters": [ { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -38644,7 +47567,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -38652,9 +47575,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -38700,38 +47621,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiUserOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all organization Memory Item entities", + "summary": "Get User entities", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-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" ] } }, "post": { - "description": "Organization-scoped AI memory item", - "operationId": "createEntity@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "createEntity@Users", "parameters": [ { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -38739,9 +47660,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -38755,12 +47674,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } } }, @@ -38771,23 +47690,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post organization Memory Item entities", + "summary": "Post User entities", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38797,9 +47716,10 @@ } } }, - "/api/v1/entities/orgMemoryItems/{id}": { + "/api/v1/entities/users/{id}": { "delete": { - "operationId": "deleteEntity@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "deleteEntity@Users", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -38810,11 +47730,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an organization Memory Item entity", + "summary": "Delete User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38824,14 +47744,15 @@ } }, "get": { - "operationId": "getEntity@OrgMemoryItems", + "description": "User - represents entity interacting with platform", + "operationId": "getEntity@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": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -38840,7 +47761,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -38848,9 +47769,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -38865,40 +47784,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an organization Memory Item entity", + "summary": "Get User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-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" ] } }, "patch": { - "operationId": "patchEntity@OrgMemoryItems", + "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": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -38907,7 +47827,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -38915,9 +47835,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -38931,12 +47849,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiUserPatchDocument" } } }, @@ -38947,23 +47865,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an organization Memory Item entity", + "summary": "Patch User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -38973,14 +47891,15 @@ } }, "put": { - "operationId": "updateEntity@OrgMemoryItems", + "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": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { @@ -38989,7 +47908,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "userGroups", "explode": false, "in": "query", "name": "include", @@ -38997,9 +47916,7 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "userGroups", "ALL" ], "type": "string" @@ -39013,12 +47930,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiUserInDocument" } } }, @@ -39029,23 +47946,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an organization Memory Item entity", + "summary": "Put User entity", "tags": [ - "AI", + "Users - Entity APIs", "entities", - "org-memory-item-controller" + "user-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -39055,87 +47972,27 @@ } } }, - "/api/v1/entities/organization": { + "/api/v1/entities/users/{userId}/apiTokens": { "get": { - "description": "Gets a basic information about organization.", - "operationId": "getOrganization", + "operationId": "getAllEntities@ApiTokens", "parameters": [ { - "description": "Return list of permissions available to logged user.", - "example": "metaInclude=permissions", - "explode": false, - "in": "query", - "name": "metaInclude", + "in": "path", + "name": "userId", + "required": true, "schema": { - "items": { - "description": "Available meta objects to include.", - "enum": [ - "permissions", - "all" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true + "type": "string" } - } - ], - "responses": { - "302": { - "description": "Redirect to entity URI." - } - }, - "summary": "Get current organization info", - "tags": [ - "Organization - Entity APIs", - "entities" - ] - } - }, - "/api/v1/entities/organization/workspaceAutomations": { - "get": { - "operationId": "getAllAutomations@WorkspaceAutomations", - "parameters": [ + }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", + "example": "bearerToken==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": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "workspaces", - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "workspace", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, { "$ref": "#/components/parameters/page" }, @@ -39173,39 +48030,169 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiApiTokenOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" + "$ref": "#/components/schemas/JsonApiApiTokenOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations across all Workspaces", + "summary": "List all api tokens for a user", "tags": [ - "Automations", + "API tokens", "entities", - "automation-organization-view-controller" + "api-token-controller" + ] + }, + "post": { + "operationId": "createEntity@ApiTokens", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "MANAGE" - ] - } + "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/organizationSettings": { + "/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": "getAllEntities@OrganizationSettings", + "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": "content==JsonNodeValue;type==SettingTypeValue", + "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": { @@ -39249,43 +48236,47 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get Organization Setting entities", + "summary": "List all custom application settings for a user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "post": { - "operationId": "createEntity@OrganizationSettings", + "operationId": "createEntity@CustomUserApplicationSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" } } }, @@ -39296,36 +48287,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Organization Setting entities", + "summary": "Post a new custom application setting for the user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-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/organizationSettings/{id}": { + "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { "delete": { - "operationId": "deleteEntity@OrganizationSettings", + "operationId": "deleteEntity@CustomUserApplicationSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/idPathParameter" } @@ -39335,74 +48328,30 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Organization Setting entity", + "summary": "Delete a custom application setting for a user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "get": { - "operationId": "getEntity@OrganizationSettings", + "operationId": "getEntity@CustomUserApplicationSettings", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", - "in": "query", - "name": "filter", + "in": "path", + "name": "userId", + "required": true, "schema": { "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get Organization Setting entity", - "tags": [ - "Organization - Entity APIs", - "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "operationId": "patchEntity@OrganizationSettings", - "parameters": [ + }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "content==JsonNodeValue;type==SettingTypeValue", + "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -39410,60 +48359,47 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Organization Setting entity", + "summary": "Get a custom application setting for a user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "custom-user-application-setting-controller" + ] }, "put": { - "operationId": "updateEntity@OrganizationSettings", + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { @@ -39475,12 +48411,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } } }, @@ -39491,39 +48427,41 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Organization Setting entity", + "summary": "Put a custom application setting for the user", "tags": [ - "Organization - Entity APIs", + "User Settings", "entities", - "organization-setting-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/themes": { + "/api/v1/entities/users/{userId}/userSettings": { "get": { - "operationId": "getAllEntities@Themes", + "operationId": "getAllEntities@UserSettings", "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": "name==someString;content==JsonNodeValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -39567,37 +48505,47 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutList" + "$ref": "#/components/schemas/JsonApiUserSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Theming entities", + "summary": "List all settings for a user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" + "user-setting-controller" ] }, "post": { - "operationId": "createEntity@Themes", + "operationId": "createEntity@UserSettings", + "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, @@ -39608,36 +48556,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Theming", + "summary": "Post new user settings for the user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-setting-controller" + ] } }, - "/api/v1/entities/themes/{id}": { + "/api/v1/entities/users/{userId}/userSettings/{id}": { "delete": { - "operationId": "deleteEntity@Themes", + "operationId": "deleteEntity@UserSettings", "parameters": [ + { + "in": "path", + "name": "userId", + "required": true, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/idPathParameter" } @@ -39647,28 +48597,30 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Theming", + "summary": "Delete a setting for a user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-setting-controller" + ] }, "get": { - "operationId": "getEntity@Themes", + "operationId": "getEntity@UserSettings", "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": "name==someString;content==JsonNodeValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -39681,95 +48633,42 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Theming", + "summary": "Get a setting for a user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" + "user-setting-controller" ] }, - "patch": { - "operationId": "patchEntity@Themes", + "put": { + "operationId": "updateEntity@UserSettings", "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;content==JsonNodeValue", - "in": "query", - "name": "filter", + "in": "path", + "name": "userId", + "required": true, "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemePatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemePatchDocument" - } - } }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Patch Theming", - "tags": [ - "Appearance", - "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "put": { - "operationId": "updateEntity@Themes", - "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;content==JsonNodeValue", + "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { @@ -39781,12 +48680,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeInDocument" + "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, @@ -39797,40 +48696,34 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiThemeOutDocument" + "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Theming", + "summary": "Put new user settings for the user", "tags": [ - "Appearance", + "User Settings", "entities", - "theme-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } + "user-setting-controller" + ] } }, - "/api/v1/entities/userGroups": { + "/api/v1/entities/workspaces": { "get": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "getAllEntities@UserGroups", + "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", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -39839,7 +48732,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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -39847,8 +48740,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -39868,7 +48761,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -39877,6 +48770,10 @@ "description": "Included meta objects", "items": { "enum": [ + "config", + "permissions", + "hierarchy", + "dataModelDatasets", "page", "all", "ALL" @@ -39894,38 +48791,38 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get UserGroup entities", + "summary": "Get Workspace entities", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, "post": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "createEntity@UserGroups", + "description": "Space of the shared interest", + "operationId": "createEntity@Workspaces", "parameters": [ { "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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -39933,8 +48830,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -39942,18 +48839,43 @@ "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/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, @@ -39964,23 +48886,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post User Group entities", + "summary": "Post Workspace entities", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -39990,10 +48912,10 @@ } } }, - "/api/v1/entities/userGroups/{id}": { + "/api/v1/entities/workspaces/{id}": { "delete": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "deleteEntity@UserGroups", + "description": "Space of the shared interest", + "operationId": "deleteEntity@Workspaces", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" @@ -40004,11 +48926,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete UserGroup entity", + "summary": "Delete Workspace entity", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40018,15 +48940,15 @@ } }, "get": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "getEntity@UserGroups", + "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", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -40035,7 +48957,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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -40043,8 +48965,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -40052,130 +48974,73 @@ "type": "array" }, "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get UserGroup entity", - "tags": [ - "UserGroups - Entity APIs", - "entities", - "user-group-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "MANAGE" - ] - } - }, - "patch": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "patchEntity@UserGroups", - "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", - "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": "parents", + "description": "Include Meta objects.", + "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,all", "explode": false, "in": "query", - "name": "include", + "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { "enum": [ - "userGroups", - "parents", + "config", + "permissions", + "hierarchy", + "dataModelDatasets", + "all", "ALL" ], "type": "string" }, - "type": "array" + "type": "array", + "uniqueItems": true }, "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch UserGroup entity", + "summary": "Get Workspace entity", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } }, - "put": { - "description": "User Group - creates tree-like structure for categorizing users", - "operationId": "updateEntity@UserGroups", + "patch": { + "description": "Space of the shared interest", + "operationId": "patchEntity@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", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -40184,7 +49049,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": "parents", + "example": "parent", "explode": false, "in": "query", "name": "include", @@ -40192,8 +49057,8 @@ "schema": { "items": { "enum": [ - "userGroups", - "parents", + "workspaces", + "parent", "ALL" ], "type": "string" @@ -40207,12 +49072,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupInDocument" + "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" } } }, @@ -40223,23 +49088,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put UserGroup entity", + "summary": "Patch Workspace entity", "tags": [ - "UserGroups - Entity APIs", + "Workspaces - Entity APIs", "entities", - "user-group-controller" + "workspace-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -40247,16 +49112,17 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/userIdentifiers": { - "get": { - "description": "UserIdentifier - represents entity interacting with platform", - "operationId": "getAllEntities@UserIdentifiers", + }, + "put": { + "description": "Space of the shared interest", + "operationId": "updateEntity@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": "firstname==someString;lastname==someString", + "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { @@ -40264,113 +49130,102 @@ } }, { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "parent", "explode": false, "in": "query", - "name": "metaInclude", + "name": "include", "required": false, "schema": { - "description": "Included meta objects", "items": { "enum": [ - "page", - "all", + "workspaces", + "parent", "ALL" ], "type": "string" }, - "type": "array", - "uniqueItems": true + "type": "array" }, "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" + "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get UserIdentifier entities", + "summary": "Put Workspace entity", "tags": [ - "User Identifiers", + "Workspaces - Entity APIs", "entities", - "user-identifier-controller" - ] + "workspace-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/userIdentifiers/{id}": { + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { "get": { - "description": "UserIdentifier - represents basic information about entity interacting with platform", - "operationId": "getEntity@UserIdentifiers", + "operationId": "getAllEntities@AggregatedFacts", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "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": "firstname==someString;lastname==someString", "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" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get UserIdentifier entity", - "tags": [ - "User Identifiers", - "entities", - "user-identifier-controller" - ] - } - }, - "/api/v1/entities/users": { - "get": { - "description": "User - represents entity interacting with platform", - "operationId": "getAllEntities@Users", - "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": "authenticationId==someString;firstname==someString", + "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", "in": "query", "name": "filter", "schema": { @@ -40379,7 +49234,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": "userGroups", + "example": "dataset,sourceFact,sourceAttribute", "explode": false, "in": "query", "name": "include", @@ -40387,7 +49242,12 @@ "schema": { "items": { "enum": [ - "userGroups", + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", "ALL" ], "type": "string" @@ -40405,9 +49265,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", @@ -40416,6 +49285,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -40433,138 +49303,134 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutList" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get User entities", + "summary": "Get all Aggregated Facts", "tags": [ - "Users - Entity APIs", + "Facts", "entities", - "user-controller" + "aggregated-fact-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - }, + } + }, + "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { "post": { - "description": "User - represents entity interacting with platform", - "operationId": "createEntity@Users", + "operationId": "searchEntities@AggregatedFacts", "parameters": [ { - "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": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { "in": "query", - "name": "include", + "name": "origin", "required": false, "schema": { - "items": { - "enum": [ - "userGroups", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "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/JsonApiUserInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiUserInDocument" + "$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/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post User entities", + "summary": "The search endpoint (beta)", "tags": [ - "Users - Entity APIs", + "Facts", "entities", - "user-controller" + "aggregated-fact-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/entities/users/{id}": { - "delete": { - "description": "User - represents entity interacting with platform", - "operationId": "deleteEntity@Users", - "parameters": [ - { - "$ref": "#/components/parameters/idPathParameter" - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/Deleted" - } - }, - "summary": "Delete 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/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { "get": { - "description": "User - represents entity interacting with platform", - "operationId": "getEntity@Users", + "operationId": "getEntity@AggregatedFacts", "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": "authenticationId==someString;firstname==someString", + "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", "in": "query", "name": "filter", "schema": { @@ -40573,7 +49439,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": "userGroups", + "example": "dataset,sourceFact,sourceAttribute", "explode": false, "in": "query", "name": "include", @@ -40581,7 +49447,12 @@ "schema": { "items": { "enum": [ - "userGroups", + "datasets", + "facts", + "attributes", + "dataset", + "sourceFact", + "sourceAttribute", "ALL" ], "type": "string" @@ -40589,6 +49460,37 @@ "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": { @@ -40596,41 +49498,62 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get User entity", + "summary": "Get an Aggregated Fact", "tags": [ - "Users - Entity APIs", + "Facts", "entities", - "user-controller" + "aggregated-fact-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - }, - "patch": { - "description": "User - represents entity interacting with platform", - "operationId": "patchEntity@Users", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { + "get": { + "operationId": "getAllEntities@AnalyticalDashboards", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "authenticationId==someString;firstname==someString", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -40639,7 +49562,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": "userGroups", + "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", "explode": false, "in": "query", "name": "include", @@ -40647,7 +49570,19 @@ "schema": { "items": { "enum": [ - "userGroups", + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -40655,168 +49590,126 @@ "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" + "$ref": "#/components/parameters/page" }, { - "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", + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, "schema": { - "type": "string" + "default": false, + "type": "boolean" } }, { - "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", + "description": "Include Meta objects.", + "example": "metaInclude=permissions,origin,accessInfo,page,all", "explode": false, "in": "query", - "name": "include", + "name": "metaInclude", "required": false, "schema": { + "description": "Included meta objects", "items": { "enum": [ - "userGroups", + "permissions", + "origin", + "accessInfo", + "page", + "all", "ALL" ], "type": "string" }, - "type": "array" + "type": "array", + "uniqueItems": true }, "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" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put User entity", + "summary": "Get all Dashboards", "tags": [ - "Users - Entity APIs", + "Dashboards", "entities", - "user-controller" + "analytical-dashboard-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to view this object type.", "permissions": [ - "MANAGE" + "VIEW" ] } - } - }, - "/api/v1/entities/users/{userId}/apiTokens": { - "get": { - "operationId": "getAllEntities@ApiTokens", + }, + "post": { + "operationId": "createEntity@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "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", + "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": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" + "items": { + "enum": [ + "userIdentifiers", + "visualizationObjects", + "analyticalDashboards", + "labels", + "metrics", + "parameters", + "datasets", + "filterContexts", + "dashboardPlugins", + "computedAttributes", + "createdBy", + "modifiedBy", + "certifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -40825,7 +49718,9 @@ "description": "Included meta objects", "items": { "enum": [ - "page", + "permissions", + "origin", + "accessInfo", "all", "ALL" ], @@ -40837,96 +49732,150 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "List all api tokens for a user", + "summary": "Post Dashboards", "tags": [ - "API tokens", + "Dashboards", "entities", - "api-token-controller" - ] - }, + "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}/analyticalDashboards/search": { "post": { - "operationId": "createEntity@ApiTokens", + "operationId": "searchEntities@AnalyticalDashboards", "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/JsonApiApiTokenInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenInDocument" + "$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/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new API token for the user", + "summary": "The search endpoint (beta)", "tags": [ - "API tokens", + "Dashboards", "entities", - "api-token-controller" - ] + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } } }, - "/api/v1/entities/users/{userId}/apiTokens/{id}": { + "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { "delete": { - "operationId": "deleteEntity@ApiTokens", + "operationId": "deleteEntity@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -40934,69 +49883,33 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an API Token for a user", + "summary": "Delete a Dashboard", "tags": [ - "API tokens", + "Dashboards", "entities", - "api-token-controller" - ] + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "get": { - "operationId": "getEntity@ApiTokens", + "operationId": "getEntity@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": "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", + "name": "objectId", "required": true, "schema": { "type": "string" @@ -41004,7 +49917,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": "applicationName==someString;content==JsonNodeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -41012,17 +49925,48 @@ } }, { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" + "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", + "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" }, { - "$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=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", @@ -41031,7 +49975,9 @@ "description": "Included meta objects", "items": { "enum": [ - "page", + "permissions", + "origin", + "accessInfo", "all", "ALL" ], @@ -41048,250 +49994,408 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "List all custom application settings for a user", + "summary": "Get a Dashboard", "tags": [ - "User Settings", + "Dashboards", "entities", - "custom-user-application-setting-controller" - ] + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, - "post": { - "operationId": "createEntity@CustomUserApplicationSettings", + "patch": { + "operationId": "patchEntity@AnalyticalDashboards", "parameters": [ { "in": "path", - "name": "userId", + "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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "explode": false, + "in": "query", + "name": "include", + "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" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } } }, "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post a new custom application setting for the user", + "summary": "Patch a Dashboard", "tags": [ - "User Settings", + "Dashboards", "entities", - "custom-user-application-setting-controller" - ] - } - }, - "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { - "delete": { - "operationId": "deleteEntity@CustomUserApplicationSettings", + "analytical-dashboard-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, + "put": { + "operationId": "updateEntity@AnalyticalDashboards", "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 custom application setting for a user", - "tags": [ - "User Settings", - "entities", - "custom-user-application-setting-controller" - ] - }, - "get": { - "operationId": "getEntity@CustomUserApplicationSettings", - "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": "applicationName==someString;content==JsonNodeValue", + "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,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins,computedAttributes", + "explode": false, + "in": "query", + "name": "include", + "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" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a custom application setting for a user", + "summary": "Put Dashboards", "tags": [ - "User Settings", + "Dashboards", "entities", - "custom-user-application-setting-controller" - ] - }, - "put": { - "operationId": "updateEntity@CustomUserApplicationSettings", + "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}/attributeHierarchies": { + "get": { + "operationId": "getAllEntities@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "applicationName==someString;content==JsonNodeValue", + "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,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" - } - } - }, - "required": true - }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put a custom application setting for the user", + "summary": "Get all Attribute Hierarchies", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "custom-user-application-setting-controller" - ] - } - }, - "/api/v1/entities/users/{userId}/userSettings": { - "get": { - "operationId": "getAllEntities@UserSettings", + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "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": "content==JsonNodeValue;type==SettingTypeValue", + "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": "filter", + "name": "include", + "required": false, "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -41300,7 +50404,7 @@ "description": "Included meta objects", "items": { "enum": [ - "page", + "origin", "all", "ALL" ], @@ -41312,96 +50416,150 @@ "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": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "List all settings for a user", + "summary": "Post Attribute Hierarchies", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] - }, + "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}/attributeHierarchies/search": { "post": { - "operationId": "createEntity@UserSettings", + "operationId": "searchEntities@AttributeHierarchies", "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/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post new user settings for the user", + "summary": "The search endpoint (beta)", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] + "attribute-hierarchy-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}": { + "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { "delete": { - "operationId": "deleteEntity@UserSettings", + "operationId": "deleteEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -41409,35 +50567,99 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a setting for a user", + "summary": "Delete an Attribute Hierarchy", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "get": { - "operationId": "getEntity@UserSettings", + "operationId": "getEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "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": { @@ -41445,59 +50667,92 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a setting for a user", + "summary": "Get an Attribute Hierarchy", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] + "attribute-hierarchy-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } }, - "put": { - "operationId": "updateEntity@UserSettings", + "patch": { + "operationId": "patchEntity@AttributeHierarchies", "parameters": [ { "in": "path", - "name": "userId", + "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { - "$ref": "#/components/parameters/idPathParameter" + "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": "content==JsonNodeValue;type==SettingTypeValue", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy,attributes", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingInDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } } }, @@ -41508,34 +50763,53 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put new user settings for the user", + "summary": "Patch an Attribute Hierarchy", "tags": [ - "User Settings", + "Attribute Hierarchies", "entities", - "user-setting-controller" - ] - } - }, - "/api/v1/entities/workspaces": { - "get": { - "description": "Space of the shared interest", - "operationId": "getAllEntities@Workspaces", + "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": [ + { + "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": { @@ -41544,7 +50818,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,attributes", "explode": false, "in": "query", "name": "include", @@ -41552,8 +50826,10 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "userIdentifiers", + "attributes", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -41561,80 +50837,93 @@ "type": "array" }, "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=config,permissions,hierarchy,dataModelDatasets,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "config", - "permissions", - "hierarchy", - "dataModelDatasets", - "page", - "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": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutList" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entities", + "summary": "Put an Attribute Hierarchy", "tags": [ - "Workspaces - Entity APIs", + "Attribute Hierarchies", "entities", - "workspace-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": { - "description": "Space of the shared interest", - "operationId": "createEntity@Workspaces", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "get": { + "operationId": "getAllEntities@Attributes", "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;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": "parent", + "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -41642,8 +50931,11 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "datasets", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -41652,9 +50944,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=config,permissions,hierarchy,dataModelDatasets,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -41663,10 +50973,9 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", + "page", "all", "ALL" ], @@ -41678,89 +50987,139 @@ "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Workspace entities", + "summary": "Get all Attributes", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-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": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{id}": { - "delete": { - "description": "Space of the shared interest", - "operationId": "deleteEntity@Workspaces", + "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { + "post": { + "operationId": "searchEntities@Attributes", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "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": { - "204": { - "$ref": "#/components/responses/Deleted" + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAttributeOutList" + } + } + }, + "description": "Request successfully processed" } }, - "summary": "Delete Workspace entity", + "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-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": [ - "MANAGE" + "VIEW" ] } - }, + } + }, + "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { "get": { - "description": "Space of the shared interest", - "operationId": "getEntity@Workspaces", + "operationId": "getEntity@Attributes", "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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -41769,7 +51128,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": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -41777,8 +51136,11 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "datasets", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -41787,9 +51149,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,all", "explode": false, "in": "query", "name": "metaInclude", @@ -41798,10 +51169,8 @@ "description": "Included meta objects", "items": { "enum": [ - "config", "permissions", - "hierarchy", - "dataModelDatasets", + "origin", "all", "ALL" ], @@ -41818,23 +51187,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Workspace entity", + "summary": "Get an Attribute", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -41844,15 +51213,27 @@ } }, "patch": { - "description": "Space of the shared interest", - "operationId": "patchEntity@Workspaces", + "operationId": "patchEntity@Attributes", "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;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { @@ -41861,7 +51242,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": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", @@ -41869,8 +51250,11 @@ "schema": { "items": { "enum": [ - "workspaces", - "parent", + "datasets", + "labels", + "attributeHierarchies", + "dataset", + "defaultView", "ALL" ], "type": "string" @@ -41884,12 +51268,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" + "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } } }, @@ -41900,23 +51284,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Workspace entity", + "summary": "Patch an Attribute (beta)", "tags": [ - "Workspaces - Entity APIs", + "Attributes", "entities", - "workspace-controller" + "attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -41924,57 +51308,54 @@ "MANAGE" ] } - }, - "put": { - "description": "Space of the shared interest", - "operationId": "updateEntity@Workspaces", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { + "post": { + "operationId": "searchEntities@AutomationResults", "parameters": [ { - "$ref": "#/components/parameters/idPathParameter" + "in": "path", + "name": "workspaceId", + "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", "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": "parent", - "explode": false, - "in": "query", - "name": "include", + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { - "items": { - "enum": [ - "workspaces", - "parent", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" + "default": false, + "type": "boolean" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" + "$ref": "#/components/schemas/EntitySearchBody" } } }, + "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -41982,35 +51363,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put Workspace entity", + "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Entity APIs", + "Automations", "entities", - "workspace-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": [ - "MANAGE" + "VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { + "/api/v1/entities/workspaces/{workspaceId}/automations": { "get": { - "operationId": "getAllEntities@AggregatedFacts", + "operationId": "getAllEntities@Automations", "parameters": [ { "in": "path", @@ -42037,7 +51418,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -42046,7 +51427,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -42054,12 +51435,23 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -42115,23 +51507,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Aggregated Facts", + "summary": "Get all Automations", "tags": [ - "Facts", + "Automations", "entities", - "aggregated-fact-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42139,11 +51531,125 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@Automations", + "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": "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", + "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/JsonApiAutomationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationInDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Automations", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { + "/api/v1/entities/workspaces/{workspaceId}/automations/search": { "post": { - "operationId": "searchEntities@AggregatedFacts", + "operationId": "searchEntities@Automations", "parameters": [ { "in": "path", @@ -42194,12 +51700,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" + "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, @@ -42208,9 +51714,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Facts", + "Automations", "entities", - "aggregated-fact-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42220,9 +51726,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { + "delete": { + "operationId": "deleteEntity@Automations", + "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 Automation", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } + }, "get": { - "operationId": "getEntity@AggregatedFacts", + "operationId": "getEntity@Automations", "parameters": [ { "in": "path", @@ -42242,7 +51786,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;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -42251,7 +51795,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,visualizationObjects,analyticalDashboards,metrics,attributes,labels,facts,computedAttributes,automationResults", "explode": false, "in": "query", "name": "include", @@ -42259,12 +51803,23 @@ "schema": { "items": { "enum": [ - "datasets", - "facts", + "notificationChannels", + "analyticalDashboards", + "userIdentifiers", + "exportDefinitions", + "users", + "visualizationObjects", + "metrics", "attributes", - "dataset", - "sourceFact", - "sourceAttribute", + "labels", + "facts", + "computedAttributes", + "automationResults", + "notificationChannel", + "analyticalDashboard", + "createdBy", + "modifiedBy", + "recipients", "ALL" ], "type": "string" @@ -42310,23 +51865,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Aggregated Fact", + "summary": "Get an Automation", "tags": [ - "Facts", + "Automations", "entities", - "aggregated-fact-controller" + "automation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42334,11 +51889,229 @@ "VIEW" ] } + }, + "patch": { + "operationId": "patchEntity@Automations", + "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;notificationChannel.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "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" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch an Automation", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } + }, + "put": { + "operationId": "updateEntity@Automations", + "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;notificationChannel.id==321;analyticalDashboard.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "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" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put an Automation", + "tags": [ + "Automations", + "entities", + "automation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "CREATE_AUTOMATION" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes": { "get": { - "operationId": "getAllEntities@AnalyticalDashboards", + "operationId": "getAllEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -42374,7 +52147,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -42383,14 +52156,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -42422,7 +52194,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -42433,7 +52205,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "page", "all", "ALL" @@ -42451,23 +52222,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Dashboards", + "summary": "Get all Computed Attributes", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42477,7 +52248,7 @@ } }, "post": { - "operationId": "createEntity@AnalyticalDashboards", + "operationId": "createEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -42489,7 +52260,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -42498,14 +52269,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -42519,7 +52289,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -42530,7 +52300,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "all", "ALL" ], @@ -42546,12 +52315,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePostOptionalIdDocument" } } }, @@ -42562,35 +52331,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Dashboards", + "summary": "Post Computed Attributes", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to create Computed Attributes", "permissions": [ - "ANALYZE" + "CREATE_COMPUTED_ATTRIBUTE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/search": { "post": { - "operationId": "searchEntities@AnalyticalDashboards", + "operationId": "searchEntities@ComputedAttributes", "parameters": [ { "in": "path", @@ -42641,12 +52410,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutList" } } }, @@ -42655,9 +52424,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42667,9 +52436,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/computedAttributes/{objectId}": { "delete": { - "operationId": "deleteEntity@AnalyticalDashboards", + "operationId": "deleteEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -42693,21 +52462,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Dashboard", + "summary": "Delete a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@AnalyticalDashboards", + "operationId": "getEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -42736,7 +52505,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -42745,14 +52514,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -42775,7 +52543,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=permissions,origin,accessInfo,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -42786,7 +52554,6 @@ "enum": [ "permissions", "origin", - "accessInfo", "all", "ALL" ], @@ -42803,23 +52570,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dashboard", + "summary": "Get a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -42829,7 +52596,7 @@ } }, "patch": { - "operationId": "patchEntity@AnalyticalDashboards", + "operationId": "patchEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -42858,7 +52625,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -42867,14 +52634,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -42891,12 +52657,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributePatchDocument" } } }, @@ -42907,33 +52673,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dashboard", + "summary": "Patch a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@AnalyticalDashboards", + "operationId": "updateEntity@ComputedAttributes", "parameters": [ { "in": "path", @@ -42962,7 +52728,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", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -42971,14 +52737,13 @@ "items": { "enum": [ "userIdentifiers", - "visualizationObjects", - "analyticalDashboards", + "facts", + "attributes", "labels", + "computedAttributes", "metrics", - "parameters", "datasets", - "filterContexts", - "dashboardPlugins", + "parameters", "createdBy", "modifiedBy", "certifiedBy", @@ -42995,12 +52760,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeInDocument" } } }, @@ -43011,35 +52776,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" + "$ref": "#/components/schemas/JsonApiComputedAttributeOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put Dashboards", + "summary": "Put a Computed Attribute", "tags": [ - "Dashboards", + "Computed Attributes", "entities", - "analytical-dashboard-controller" + "computed-attribute-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { "get": { - "operationId": "getAllEntities@AttributeHierarchies", + "operationId": "getAllEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43066,35 +52831,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" - }, { "$ref": "#/components/parameters/page" }, @@ -43142,23 +52885,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attribute Hierarchies", + "summary": "Get all Custom Application Settings", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43168,7 +52911,7 @@ } }, "post": { - "operationId": "createEntity@AttributeHierarchies", + "operationId": "createEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43178,28 +52921,6 @@ "type": "string" } }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,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", @@ -43227,12 +52948,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } } }, @@ -43243,35 +52964,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Attribute Hierarchies", + "summary": "Post Custom Application Settings", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { "post": { - "operationId": "searchEntities@AttributeHierarchies", + "operationId": "searchEntities@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43322,12 +53037,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, @@ -43336,9 +53051,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43348,9 +53063,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { "delete": { - "operationId": "deleteEntity@AttributeHierarchies", + "operationId": "deleteEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43374,21 +53089,15 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Attribute Hierarchy", + "summary": "Delete a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] }, "get": { - "operationId": "getEntity@AttributeHierarchies", + "operationId": "getEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43408,35 +53117,13 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" - }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -43474,23 +53161,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute Hierarchy", + "summary": "Get a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" + "custom-application-setting-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43500,7 +53187,7 @@ } }, "patch": { - "operationId": "patchEntity@AttributeHierarchies", + "operationId": "patchEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43520,46 +53207,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } } }, @@ -43570,33 +53235,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute Hierarchy", + "summary": "Patch a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] }, "put": { - "operationId": "updateEntity@AttributeHierarchies", + "operationId": "updateEntity@CustomApplicationSettings", "parameters": [ { "in": "path", @@ -43616,46 +53275,24 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "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": "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" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } } }, @@ -43666,35 +53303,29 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Attribute Hierarchy", + "summary": "Put a Custom Application Setting", "tags": [ - "Attribute Hierarchies", + "Workspaces - Settings", "entities", - "attribute-hierarchy-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } + "custom-application-setting-controller" + ] } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { "get": { - "operationId": "getAllEntities@Attributes", + "operationId": "getAllEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -43721,7 +53352,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": { @@ -43730,7 +53361,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", "explode": false, "in": "query", "name": "include", @@ -43738,11 +53369,9 @@ "schema": { "items": { "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -43794,39 +53423,139 @@ } ], "responses": { - "200": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Plugins", + "tags": [ + "Plugins", + "entities", + "dashboard-plugin-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@DashboardPlugins", + "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/JsonApiDashboardPluginPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Attributes", + "summary": "Post Plugins", "tags": [ - "Attributes", + "Plugins", "entities", - "attribute-controller" + "dashboard-plugin-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" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { "post": { - "operationId": "searchEntities@Attributes", + "operationId": "searchEntities@DashboardPlugins", "parameters": [ { "in": "path", @@ -43877,12 +53606,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, @@ -43891,9 +53620,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Attributes", + "Plugins", "entities", - "attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -43903,9 +53632,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { + "delete": { + "operationId": "deleteEntity@DashboardPlugins", + "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 Plugin", + "tags": [ + "Plugins", + "entities", + "dashboard-plugin-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, "get": { - "operationId": "getEntity@Attributes", + "operationId": "getEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -43925,7 +53692,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": { @@ -43934,7 +53701,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", "explode": false, "in": "query", "name": "include", @@ -43942,11 +53709,9 @@ "schema": { "items": { "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -43992,23 +53757,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Attribute", + "summary": "Get a Plugin", "tags": [ - "Attributes", + "Plugins", "entities", - "attribute-controller" + "dashboard-plugin-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44018,7 +53783,7 @@ } }, "patch": { - "operationId": "patchEntity@Attributes", + "operationId": "patchEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -44038,7 +53803,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": { @@ -44047,7 +53812,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", "explode": false, "in": "query", "name": "include", @@ -44055,11 +53820,9 @@ "schema": { "items": { "enum": [ - "datasets", - "labels", - "attributeHierarchies", - "dataset", - "defaultView", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -44073,12 +53836,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributePatchDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } } }, @@ -44089,35 +53852,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAttributeOutDocument" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Attribute (beta)", + "summary": "Patch a Plugin", "tags": [ - "Attributes", + "Plugins", "entities", - "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}/automationResults/search": { - "post": { - "operationId": "searchEntities@AutomationResults", + }, + "put": { + "operationId": "updateEntity@DashboardPlugins", "parameters": [ { "in": "path", @@ -44128,39 +53889,57 @@ } }, { + "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", + "explode": false, + "in": "query", + "name": "include", "required": false, "schema": { - "default": false, - "type": "boolean" - } + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EntitySearchBody" + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } } }, - "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { @@ -44168,35 +53947,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationResultOutList" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Put a Plugin", "tags": [ - "Automations", + "Plugins", "entities", - "automation-result-controller" + "dashboard-plugin-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" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations": { + "/api/v1/entities/workspaces/{workspaceId}/datasets": { "get": { - "operationId": "getAllEntities@Automations", + "operationId": "getAllEntities@Datasets", "parameters": [ { "in": "path", @@ -44223,7 +54002,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -44232,7 +54011,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", @@ -44240,17 +54019,12 @@ "schema": { "items": { "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", "ALL" ], "type": "string" @@ -44306,23 +54080,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Automations", + "summary": "Get all Datasets", "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44330,119 +54104,11 @@ "VIEW" ] } - }, - "post": { - "operationId": "createEntity@Automations", - "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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "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/JsonApiAutomationInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" - } - } - }, - "required": true - }, - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Post Automations", - "tags": [ - "Automations", - "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } } }, - "/api/v1/entities/workspaces/{workspaceId}/automations/search": { + "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { "post": { - "operationId": "searchEntities@Automations", + "operationId": "searchEntities@Datasets", "parameters": [ { "in": "path", @@ -44493,12 +54159,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutList" + "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, @@ -44507,168 +54173,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Automations", - "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { - "delete": { - "operationId": "deleteEntity@Automations", - "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 Automation", - "tags": [ - "Automations", - "entities", - "automation-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "CREATE_AUTOMATION" - ] - } - }, - "get": { - "operationId": "getEntity@Automations", - "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;notificationChannel.id==321;analyticalDashboard.id==321", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get an Automation", - "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44676,9 +54183,11 @@ "VIEW" ] } - }, - "patch": { - "operationId": "patchEntity@Automations", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { + "get": { + "operationId": "getEntity@Datasets", "parameters": [ { "in": "path", @@ -44698,7 +54207,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -44707,7 +54216,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", @@ -44715,17 +54224,12 @@ "schema": { "items": { "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", "ALL" ], "type": "string" @@ -44733,55 +54237,71 @@ "type": "array" }, "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" - } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" } }, - "required": true - }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Automation", + "summary": "Get a Dataset", "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-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": [ - "CREATE_AUTOMATION" + "VIEW" ] } }, - "put": { - "operationId": "updateEntity@Automations", + "patch": { + "operationId": "patchEntity@Datasets", "parameters": [ { "in": "path", @@ -44801,7 +54321,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;notificationChannel.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -44810,7 +54330,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": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", + "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", @@ -44818,17 +54338,12 @@ "schema": { "items": { "enum": [ - "notificationChannels", - "analyticalDashboards", - "userIdentifiers", - "exportDefinitions", - "users", - "automationResults", - "notificationChannel", - "analyticalDashboard", - "createdBy", - "modifiedBy", - "recipients", + "attributes", + "facts", + "aggregatedFacts", + "datasets", + "workspaceDataFilters", + "references", "ALL" ], "type": "string" @@ -44842,12 +54357,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationInDocument" + "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } } }, @@ -44858,35 +54373,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiAutomationOutDocument" + "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Automation", + "summary": "Patch a Dataset (beta)", "tags": [ - "Automations", + "Datasets", "entities", - "automation-controller" + "dataset-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_AUTOMATION" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { "get": { - "operationId": "getAllEntities@CustomApplicationSettings", + "operationId": "getAllEntities@ExportDefinitions", "parameters": [ { "in": "path", @@ -44913,13 +54428,40 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "$ref": "#/components/parameters/page" }, @@ -44967,23 +54509,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Custom Application Settings", + "summary": "Get all Export Definitions", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -44993,7 +54535,7 @@ } }, "post": { - "operationId": "createEntity@CustomApplicationSettings", + "operationId": "createEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -45003,6 +54545,33 @@ "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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", @@ -45030,12 +54599,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" } } }, @@ -45046,29 +54615,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Custom Application Settings", + "summary": "Post Export Definitions", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search": { "post": { - "operationId": "searchEntities@CustomApplicationSettings", + "operationId": "searchEntities@ExportDefinitions", "parameters": [ { "in": "path", @@ -45119,12 +54694,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } } }, @@ -45133,9 +54708,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45145,9 +54720,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}": { "delete": { - "operationId": "deleteEntity@CustomApplicationSettings", + "operationId": "deleteEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -45171,15 +54746,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Custom Application Setting", + "summary": "Delete an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "get": { - "operationId": "getEntity@CustomApplicationSettings", + "operationId": "getEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -45199,13 +54780,40 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", @@ -45243,23 +54851,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Custom Application Setting", + "summary": "Get an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" + "export-definition-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45269,7 +54877,7 @@ } }, "patch": { - "operationId": "patchEntity@CustomApplicationSettings", + "operationId": "patchEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -45289,24 +54897,51 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" } } }, @@ -45317,27 +54952,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Custom Application Setting", + "summary": "Patch an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } }, "put": { - "operationId": "updateEntity@CustomApplicationSettings", + "operationId": "updateEntity@ExportDefinitions", "parameters": [ { "in": "path", @@ -45357,24 +54998,51 @@ }, { "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;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "visualizationObjects", + "analyticalDashboards", + "automations", + "userIdentifiers", + "visualizationObject", + "analyticalDashboard", + "automation", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" } } }, @@ -45385,29 +55053,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Custom Application Setting", + "summary": "Put an Export Definition", "tags": [ - "Workspaces - Settings", + "Export Definitions", "entities", - "custom-application-setting-controller" - ] + "export-definition-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { + "/api/v1/entities/workspaces/{workspaceId}/facts": { "get": { - "operationId": "getAllEntities@DashboardPlugins", + "operationId": "getAllEntities@Facts", "parameters": [ { "in": "path", @@ -45434,7 +55108,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", "in": "query", "name": "filter", "schema": { @@ -45443,7 +55117,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "dataset", "explode": false, "in": "query", "name": "include", @@ -45451,9 +55125,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "datasets", + "dataset", "ALL" ], "type": "string" @@ -45482,7 +55155,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -45491,153 +55164,54 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "page", "all", "ALL" ], "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "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": "Get all Plugins", - "tags": [ - "Plugins", - "entities", - "dashboard-plugin-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - }, - "post": { - "operationId": "createEntity@DashboardPlugins", - "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/JsonApiDashboardPluginPostOptionalIdDocument" - } + }, + "type": "array", + "uniqueItems": true }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" - } - } - }, - "required": true - }, + "style": "form" + } + ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Plugins", + "summary": "Get all Facts", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-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}/dashboardPlugins/search": { + "/api/v1/entities/workspaces/{workspaceId}/facts/search": { "post": { - "operationId": "searchEntities@DashboardPlugins", + "operationId": "searchEntities@Facts", "parameters": [ { "in": "path", @@ -45688,12 +55262,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" + "$ref": "#/components/schemas/JsonApiFactOutList" } } }, @@ -45702,9 +55276,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45714,47 +55288,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { - "delete": { - "operationId": "deleteEntity@DashboardPlugins", - "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 Plugin", - "tags": [ - "Plugins", - "entities", - "dashboard-plugin-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, + "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}": { "get": { - "operationId": "getEntity@DashboardPlugins", + "operationId": "getEntity@Facts", "parameters": [ { "in": "path", @@ -45774,7 +55310,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", "in": "query", "name": "filter", "schema": { @@ -45783,7 +55319,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "dataset", "explode": false, "in": "query", "name": "include", @@ -45791,9 +55327,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "datasets", + "dataset", "ALL" ], "type": "string" @@ -45813,7 +55348,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -45822,6 +55357,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -45839,23 +55375,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Plugin", + "summary": "Get a Fact", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -45865,7 +55401,7 @@ } }, "patch": { - "operationId": "patchEntity@DashboardPlugins", + "operationId": "patchEntity@Facts", "parameters": [ { "in": "path", @@ -45885,7 +55421,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", "in": "query", "name": "filter", "schema": { @@ -45894,7 +55430,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "dataset", "explode": false, "in": "query", "name": "include", @@ -45902,9 +55438,8 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "datasets", + "dataset", "ALL" ], "type": "string" @@ -45918,12 +55453,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiFactPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" + "$ref": "#/components/schemas/JsonApiFactPatchDocument" } } }, @@ -45934,33 +55469,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFactOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Plugin", + "summary": "Patch a Fact (beta)", "tags": [ - "Plugins", + "Facts", "entities", - "dashboard-plugin-controller" + "fact-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } - }, - "put": { - "operationId": "updateEntity@DashboardPlugins", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/filterContexts": { + "get": { + "operationId": "getAllEntities@FilterContexts", "parameters": [ { "in": "path", @@ -45971,16 +55508,23 @@ } }, { - "in": "path", - "name": "objectId", - "required": true, + "in": "query", + "name": "origin", + "required": false, "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], "type": "string" } }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", + "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { @@ -45989,7 +55533,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy", + "example": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -45997,9 +55541,12 @@ "schema": { "items": { "enum": [ - "userIdentifiers", - "createdBy", - "modifiedBy", + "attributes", + "datasets", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -46007,57 +55554,81 @@ "type": "array" }, "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" - } + }, + { + "$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" } }, - "required": true - }, + { + "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/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Plugin", + "summary": "Get all Filter Context", "tags": [ - "Plugins", + "Filter Context", "entities", - "dashboard-plugin-controller" + "filter-context-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}/datasets": { - "get": { - "operationId": "getAllEntities@Datasets", + }, + "post": { + "operationId": "createEntity@FilterContexts", "parameters": [ { "in": "path", @@ -46067,33 +55638,9 @@ "type": "string" } }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, { "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": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -46102,11 +55649,11 @@ "items": { "enum": [ "attributes", - "facts", - "aggregatedFacts", "datasets", - "workspaceDataFilters", - "references", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -46115,27 +55662,9 @@ }, "style": "form" }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -46145,7 +55674,6 @@ "items": { "enum": [ "origin", - "page", "all", "ALL" ], @@ -46157,40 +55685,55 @@ "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Datasets", + "summary": "Post Filter Context", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-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" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { + "/api/v1/entities/workspaces/{workspaceId}/filterContexts/search": { "post": { - "operationId": "searchEntities@Datasets", + "operationId": "searchEntities@FilterContexts", "parameters": [ { "in": "path", @@ -46241,12 +55784,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutList" + "$ref": "#/components/schemas/JsonApiFilterContextOutList" } } }, @@ -46255,9 +55798,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46267,9 +55810,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}": { + "delete": { + "operationId": "deleteEntity@FilterContexts", + "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 Filter Context", + "tags": [ + "Filter Context", + "entities", + "filter-context-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, "get": { - "operationId": "getEntity@Datasets", + "operationId": "getEntity@FilterContexts", "parameters": [ { "in": "path", @@ -46298,7 +55879,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": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -46307,11 +55888,11 @@ "items": { "enum": [ "attributes", - "facts", - "aggregatedFacts", "datasets", - "workspaceDataFilters", - "references", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -46357,23 +55938,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Dataset", + "summary": "Get a Filter Context", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46383,7 +55964,7 @@ } }, "patch": { - "operationId": "patchEntity@Datasets", + "operationId": "patchEntity@FilterContexts", "parameters": [ { "in": "path", @@ -46412,7 +55993,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": "attributes,datasets,labels,computedAttributes,metrics,facts", "explode": false, "in": "query", "name": "include", @@ -46421,11 +56002,109 @@ "items": { "enum": [ "attributes", + "datasets", + "labels", + "computedAttributes", + "metrics", "facts", - "aggregatedFacts", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Patch a Filter Context", + "tags": [ + "Filter Context", + "entities", + "filter-context-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "ANALYZE" + ] + } + }, + "put": { + "operationId": "updateEntity@FilterContexts", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "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,datasets,labels,computedAttributes,metrics,facts", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "attributes", "datasets", - "workspaceDataFilters", - "references", + "labels", + "computedAttributes", + "metrics", + "facts", "ALL" ], "type": "string" @@ -46439,12 +56118,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterContextInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterContextInDocument" } } }, @@ -46455,35 +56134,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiDatasetOutDocument" + "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Dataset (beta)", + "summary": "Put a Filter Context", "tags": [ - "Datasets", + "Filter Context", "entities", - "dataset-controller" + "filter-context-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "MANAGE" + "ANALYZE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { + "/api/v1/entities/workspaces/{workspaceId}/filterViews": { "get": { - "operationId": "getAllEntities@ExportDefinitions", + "operationId": "getAllEntities@FilterViews", "parameters": [ { "in": "path", @@ -46510,7 +56189,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -46519,7 +56198,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -46527,15 +56206,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -46564,7 +56238,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -46573,7 +56247,6 @@ "description": "Included meta objects", "items": { "enum": [ - "origin", "page", "all", "ALL" @@ -46591,23 +56264,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Export Definitions", + "summary": "Get all Filter views", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46617,7 +56290,7 @@ } }, "post": { - "operationId": "createEntity@ExportDefinitions", + "operationId": "createEntity@FilterViews", "parameters": [ { "in": "path", @@ -46629,7 +56302,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -46637,15 +56310,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -46653,40 +56321,18 @@ "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/JsonApiExportDefinitionPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } } }, @@ -46697,35 +56343,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Export Definitions", + "summary": "Post Filter views", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search": { + "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { "post": { - "operationId": "searchEntities@ExportDefinitions", + "operationId": "searchEntities@FilterViews", "parameters": [ { "in": "path", @@ -46776,12 +56422,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" + "$ref": "#/components/schemas/JsonApiFilterViewOutList" } } }, @@ -46790,9 +56436,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46802,9 +56448,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { "delete": { - "operationId": "deleteEntity@ExportDefinitions", + "operationId": "deleteEntity@FilterViews", "parameters": [ { "in": "path", @@ -46828,21 +56474,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete an Export Definition", + "summary": "Delete Filter view", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } }, "get": { - "operationId": "getEntity@ExportDefinitions", + "operationId": "getEntity@FilterViews", "parameters": [ { "in": "path", @@ -46862,7 +56508,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -46871,7 +56517,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -46879,15 +56525,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -46904,28 +56545,6 @@ "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": { @@ -46933,23 +56552,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get an Export Definition", + "summary": "Get Filter view", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -46959,7 +56578,7 @@ } }, "patch": { - "operationId": "patchEntity@ExportDefinitions", + "operationId": "patchEntity@FilterViews", "parameters": [ { "in": "path", @@ -46979,7 +56598,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -46988,7 +56607,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -46996,15 +56615,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -47018,12 +56632,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" + "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" } } }, @@ -47034,33 +56648,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch an Export Definition", + "summary": "Patch Filter view", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } }, "put": { - "operationId": "updateEntity@ExportDefinitions", + "operationId": "updateEntity@FilterViews", "parameters": [ { "in": "path", @@ -47080,7 +56694,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;visualizationObject.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { @@ -47089,7 +56703,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": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", + "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", @@ -47097,15 +56711,10 @@ "schema": { "items": { "enum": [ - "visualizationObjects", "analyticalDashboards", - "automations", - "userIdentifiers", - "visualizationObject", + "users", "analyticalDashboard", - "automation", - "createdBy", - "modifiedBy", + "user", "ALL" ], "type": "string" @@ -47119,12 +56728,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" + "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } } }, @@ -47135,35 +56744,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" + "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put an Export Definition", + "summary": "Put Filter views", "tags": [ - "Export Definitions", + "Filter Views", "entities", - "export-definition-controller" + "filter-view-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ - "ANALYZE" + "CREATE_FILTER_VIEW" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/facts": { + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars": { "get": { - "operationId": "getAllEntities@Facts", + "operationId": "getAllEntities@FiscalCalendars", "parameters": [ { "in": "path", @@ -47190,7 +56799,185 @@ }, { "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", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/components/parameters/page" + }, + { + "$ref": "#/components/parameters/size" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=page,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "page", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Fiscal Calendars", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}": { + "get": { + "operationId": "getEntity@FiscalCalendars", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, + { + "in": "header", + "name": "X-GDC-VALIDATE-RELATIONS", + "required": false, + "schema": { + "default": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get a Fiscal Calendar", + "tags": [ + "Fiscal Calendars", + "entities", + "fiscal-calendar-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + } + }, + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { + "get": { + "operationId": "getAllEntities@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "query", + "name": "origin", + "required": false, + "schema": { + "default": "ALL", + "description": "Defines scope of origin of objects. All by default.", + "enum": [ + "ALL", + "PARENTS", + "NATIVE" + ], + "type": "string" + } + }, + { + "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -47199,7 +56986,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", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -47207,8 +56994,10 @@ "schema": { "items": { "enum": [ - "datasets", - "dataset", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -47260,39 +57049,140 @@ } ], "responses": { - "200": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Get all Knowledge Recommendations", + "tags": [ + "Knowledge Recommendations", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to view this object type.", + "permissions": [ + "VIEW" + ] + } + }, + "post": { + "operationId": "createEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "metric,analyticalDashboard", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Facts", + "summary": "Post Knowledge Recommendations", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-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}/facts/search": { + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { "post": { - "operationId": "searchEntities@Facts", + "operationId": "searchEntities@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -47343,12 +57233,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } } }, @@ -47357,9 +57247,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47369,9 +57259,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "delete": { + "operationId": "deleteEntity@KnowledgeRecommendations", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Knowledge Recommendation", + "tags": [ + "Knowledge Recommendations", + "entities", + "knowledge-recommendation-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Facts", + "operationId": "getEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -47391,7 +57319,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", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -47400,7 +57328,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", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -47408,8 +57336,10 @@ "schema": { "items": { "enum": [ - "datasets", - "dataset", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -47455,23 +57385,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Fact", + "summary": "Get a Knowledge Recommendation", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47481,7 +57411,7 @@ } }, "patch": { - "operationId": "patchEntity@Facts", + "operationId": "patchEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -47501,7 +57431,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", + "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -47510,7 +57440,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", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -47518,8 +57448,10 @@ "schema": { "items": { "enum": [ - "datasets", - "dataset", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -47533,12 +57465,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactPatchDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactPatchDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } } }, @@ -47549,23 +57481,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFactOutDocument" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Fact (beta)", + "summary": "Patch a Knowledge Recommendation", "tags": [ - "Facts", + "Knowledge Recommendations", "entities", - "fact-controller" + "knowledge-recommendation-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -47573,11 +57505,9 @@ "MANAGE" ] } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts": { - "get": { - "operationId": "getAllEntities@FilterContexts", + }, + "put": { + "operationId": "updateEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", @@ -47588,23 +57518,16 @@ } }, { - "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" } }, { "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": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { @@ -47613,7 +57536,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,datasets,labels", + "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", @@ -47621,9 +57544,10 @@ "schema": { "items": { "enum": [ - "attributes", - "datasets", - "labels", + "metrics", + "analyticalDashboards", + "metric", + "analyticalDashboard", "ALL" ], "type": "string" @@ -47631,81 +57555,57 @@ "type": "array" }, "style": "form" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "origin", - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + } + } + }, + "required": true + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Filter Context", + "summary": "Put a Knowledge Recommendation", "tags": [ - "Filter Context", + "Knowledge Recommendations", "entities", - "filter-context-controller" + "knowledge-recommendation-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" ] } - }, - "post": { - "operationId": "createEntity@FilterContexts", + } + }, + "/api/v1/entities/workspaces/{workspaceId}/labels": { + "get": { + "operationId": "getAllEntities@Labels", "parameters": [ { "in": "path", @@ -47715,9 +57615,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;attribute.id==321", + "in": "query", + "name": "filter", + "schema": { + "type": "string" + } + }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attributes,datasets,labels", + "example": "attribute", "explode": false, "in": "query", "name": "include", @@ -47726,8 +57650,7 @@ "items": { "enum": [ "attributes", - "datasets", - "labels", + "attribute", "ALL" ], "type": "string" @@ -47736,9 +57659,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=origin,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -47747,7 +57688,9 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", + "page", "all", "ALL" ], @@ -47759,55 +57702,40 @@ "style": "form" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" - } - } - }, - "required": true - }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Post Filter Context", + "summary": "Get all Labels", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-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}/filterContexts/search": { + "/api/v1/entities/workspaces/{workspaceId}/labels/search": { "post": { - "operationId": "searchEntities@FilterContexts", + "operationId": "searchEntities@Labels", "parameters": [ { "in": "path", @@ -47858,12 +57786,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiLabelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutList" + "$ref": "#/components/schemas/JsonApiLabelOutList" } } }, @@ -47872,9 +57800,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -47884,47 +57812,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}": { - "delete": { - "operationId": "deleteEntity@FilterContexts", - "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 Filter Context", - "tags": [ - "Filter Context", - "entities", - "filter-context-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, + "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { "get": { - "operationId": "getEntity@FilterContexts", + "operationId": "getEntity@Labels", "parameters": [ { "in": "path", @@ -47944,7 +57834,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": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { @@ -47953,7 +57843,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,datasets,labels", + "example": "attribute", "explode": false, "in": "query", "name": "include", @@ -47962,8 +57852,7 @@ "items": { "enum": [ "attributes", - "datasets", - "labels", + "attribute", "ALL" ], "type": "string" @@ -47983,7 +57872,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -47992,6 +57881,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -48009,23 +57899,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Filter Context", + "summary": "Get a Label", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48035,102 +57925,7 @@ } }, "patch": { - "operationId": "patchEntity@FilterContexts", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "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,datasets,labels", - "explode": false, - "in": "query", - "name": "include", - "required": false, - "schema": { - "items": { - "enum": [ - "attributes", - "datasets", - "labels", - "ALL" - ], - "type": "string" - }, - "type": "array" - }, - "style": "form" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" - } - } - }, - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Patch a Filter Context", - "tags": [ - "Filter Context", - "entities", - "filter-context-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", - "permissions": [ - "ANALYZE" - ] - } - }, - "put": { - "operationId": "updateEntity@FilterContexts", + "operationId": "patchEntity@Labels", "parameters": [ { "in": "path", @@ -48150,7 +57945,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": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { @@ -48159,7 +57954,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,datasets,labels", + "example": "attribute", "explode": false, "in": "query", "name": "include", @@ -48168,8 +57963,7 @@ "items": { "enum": [ "attributes", - "datasets", - "labels", + "attribute", "ALL" ], "type": "string" @@ -48183,12 +57977,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextInDocument" + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextInDocument" + "$ref": "#/components/schemas/JsonApiLabelPatchDocument" } } }, @@ -48199,35 +57993,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" + "$ref": "#/components/schemas/JsonApiLabelOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Filter Context", + "summary": "Patch a Label (beta)", "tags": [ - "Filter Context", + "Labels", "entities", - "filter-context-controller" + "label-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "ANALYZE" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { "get": { - "operationId": "getAllEntities@FilterViews", + "operationId": "getAllEntities@MemoryItems", "parameters": [ { "in": "path", @@ -48254,7 +58048,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -48263,7 +58057,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -48271,10 +58065,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -48303,7 +58096,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=page,all", + "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -48312,6 +58105,7 @@ "description": "Included meta objects", "items": { "enum": [ + "origin", "page", "all", "ALL" @@ -48329,23 +58123,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Filter views", + "summary": "Get all Memory Items", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48355,7 +58149,7 @@ } }, "post": { - "operationId": "createEntity@FilterViews", + "operationId": "createEntity@MemoryItems", "parameters": [ { "in": "path", @@ -48367,7 +58161,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -48375,10 +58169,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -48386,18 +58179,40 @@ "type": "array" }, "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } } }, @@ -48408,35 +58223,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Filter views", + "summary": "Post Memory Items", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { "post": { - "operationId": "searchEntities@FilterViews", + "operationId": "searchEntities@MemoryItems", "parameters": [ { "in": "path", @@ -48487,12 +58302,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutList" + "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, @@ -48501,9 +58316,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48513,9 +58328,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { "delete": { - "operationId": "deleteEntity@FilterViews", + "operationId": "deleteEntity@MemoryItems", "parameters": [ { "in": "path", @@ -48539,21 +58354,21 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete Filter view", + "summary": "Delete a Memory Item", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "get": { - "operationId": "getEntity@FilterViews", + "operationId": "getEntity@MemoryItems", "parameters": [ { "in": "path", @@ -48573,7 +58388,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -48582,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": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -48590,10 +58405,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -48610,6 +58424,28 @@ "default": false, "type": "boolean" } + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" } ], "responses": { @@ -48617,23 +58453,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get Filter view", + "summary": "Get a Memory Item", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -48643,7 +58479,7 @@ } }, "patch": { - "operationId": "patchEntity@FilterViews", + "operationId": "patchEntity@MemoryItems", "parameters": [ { "in": "path", @@ -48663,7 +58499,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -48672,7 +58508,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -48680,10 +58516,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -48697,12 +58532,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } } }, @@ -48713,33 +58548,33 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch Filter view", + "summary": "Patch a Memory Item", "tags": [ - "Filter Views", + "Memory Items", "entities", - "filter-view-controller" + "memory-item-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", + "description": "Contains minimal permission level required to manage this object type.", "permissions": [ - "CREATE_FILTER_VIEW" + "MANAGE" ] } }, "put": { - "operationId": "updateEntity@FilterViews", + "operationId": "updateEntity@MemoryItems", "parameters": [ { "in": "path", @@ -48759,7 +58594,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -48768,7 +58603,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "analyticalDashboard,user", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -48776,10 +58611,9 @@ "schema": { "items": { "enum": [ - "analyticalDashboards", - "users", - "analyticalDashboard", - "user", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -48793,12 +58627,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewInDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } } }, @@ -48809,213 +58643,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Put Filter views", - "tags": [ - "Filter Views", - "entities", - "filter-view-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage Filter Views", - "permissions": [ - "CREATE_FILTER_VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars": { - "get": { - "operationId": "getAllEntities@FiscalCalendars", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/page" - }, - { - "$ref": "#/components/parameters/size" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - }, - { - "description": "Include Meta objects.", - "example": "metaInclude=page,all", - "explode": false, - "in": "query", - "name": "metaInclude", - "required": false, - "schema": { - "description": "Included meta objects", - "items": { - "enum": [ - "page", - "all", - "ALL" - ], - "type": "string" - }, - "type": "array", - "uniqueItems": true - }, - "style": "form" - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "Get all Fiscal Calendars", - "tags": [ - "Fiscal Calendars", - "entities", - "fiscal-calendar-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/fiscalCalendars/{objectId}": { - "get": { - "operationId": "getEntity@FiscalCalendars", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "path", - "name": "objectId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString", - "in": "query", - "name": "filter", - "schema": { - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiFiscalCalendarOutDocument" + "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Fiscal Calendar", + "summary": "Put a Memory Item", "tags": [ - "Fiscal Calendars", + "Memory Items", "entities", - "fiscal-calendar-controller" + "memory-item-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}/knowledgeRecommendations": { + "/api/v1/entities/workspaces/{workspaceId}/metrics": { "get": { - "operationId": "getAllEntities@KnowledgeRecommendations", + "operationId": "getAllEntities@Metrics", "parameters": [ { "in": "path", @@ -49042,7 +58698,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49051,7 +58707,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -49059,10 +58715,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49091,7 +58754,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -49100,6 +58763,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "page", "all", @@ -49118,23 +58782,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Knowledge Recommendations", + "summary": "Get all Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49144,7 +58808,7 @@ } }, "post": { - "operationId": "createEntity@KnowledgeRecommendations", + "operationId": "createEntity@Metrics", "parameters": [ { "in": "path", @@ -49156,7 +58820,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -49164,10 +58828,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49178,7 +58849,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -49187,6 +58858,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -49203,12 +58875,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } } }, @@ -49219,35 +58891,35 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Knowledge Recommendations", + "summary": "Post Metrics", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { - "description": "Contains minimal permission level required to manage this object type.", + "description": "Contains minimal permission level required to create Metrics", "permissions": [ - "MANAGE" + "CREATE_METRIC" ] } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { "post": { - "operationId": "searchEntities@KnowledgeRecommendations", + "operationId": "searchEntities@Metrics", "parameters": [ { "in": "path", @@ -49298,12 +58970,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" + "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, @@ -49312,9 +58984,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49324,9 +58996,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { "delete": { - "operationId": "deleteEntity@KnowledgeRecommendations", + "operationId": "deleteEntity@Metrics", "parameters": [ { "in": "path", @@ -49350,11 +59022,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Knowledge Recommendation", + "summary": "Delete a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49364,7 +59036,7 @@ } }, "get": { - "operationId": "getEntity@KnowledgeRecommendations", + "operationId": "getEntity@Metrics", "parameters": [ { "in": "path", @@ -49384,7 +59056,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49393,7 +59065,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -49401,10 +59073,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49424,7 +59103,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -49433,6 +59112,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -49450,23 +59130,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Knowledge Recommendation", + "summary": "Get a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49476,7 +59156,7 @@ } }, "patch": { - "operationId": "patchEntity@KnowledgeRecommendations", + "operationId": "patchEntity@Metrics", "parameters": [ { "in": "path", @@ -49496,7 +59176,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49505,7 +59185,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -49513,10 +59193,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49530,12 +59217,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" + "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } } }, @@ -49546,23 +59233,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Knowledge Recommendation", + "summary": "Patch a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49572,7 +59259,7 @@ } }, "put": { - "operationId": "updateEntity@KnowledgeRecommendations", + "operationId": "updateEntity@Metrics", "parameters": [ { "in": "path", @@ -49592,7 +59279,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49601,7 +59288,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "metric,analyticalDashboard", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -49609,10 +59296,17 @@ "schema": { "items": { "enum": [ + "userIdentifiers", + "facts", + "attributes", + "labels", + "computedAttributes", "metrics", - "analyticalDashboards", - "metric", - "analyticalDashboard", + "datasets", + "parameters", + "createdBy", + "modifiedBy", + "certifiedBy", "ALL" ], "type": "string" @@ -49626,12 +59320,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" + "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, @@ -49642,23 +59336,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" + "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Knowledge Recommendation", + "summary": "Put a Metric", "tags": [ - "AI", + "Metrics", "entities", - "knowledge-recommendation-controller" + "metric-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -49668,9 +59362,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels": { + "/api/v1/entities/workspaces/{workspaceId}/parameters": { "get": { - "operationId": "getAllEntities@Labels", + "operationId": "getAllEntities@Parameters", "parameters": [ { "in": "path", @@ -49697,7 +59391,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49706,7 +59400,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -49714,8 +59408,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -49771,23 +59466,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Labels", + "summary": "Get all Parameters", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49795,11 +59490,111 @@ "VIEW" ] } + }, + "post": { + "operationId": "createEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", + "example": "createdBy,modifiedBy", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + }, + { + "description": "Include Meta objects.", + "example": "metaInclude=origin,all", + "explode": false, + "in": "query", + "name": "metaInclude", + "required": false, + "schema": { + "description": "Included meta objects", + "items": { + "enum": [ + "origin", + "all", + "ALL" + ], + "type": "string" + }, + "type": "array", + "uniqueItems": true + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Post Parameters", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/search": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { "post": { - "operationId": "searchEntities@Labels", + "operationId": "searchEntities@Parameters", "parameters": [ { "in": "path", @@ -49850,12 +59645,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutList" + "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, @@ -49864,9 +59659,9 @@ }, "summary": "The search endpoint (beta)", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49876,9 +59671,47 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "delete": { + "operationId": "deleteEntity@Parameters", + "parameters": [ + { + "in": "path", + "name": "workspaceId", + "required": true, + "schema": { + "type": "string" + } + }, + { + "in": "path", + "name": "objectId", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/Deleted" + } + }, + "summary": "Delete a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, "get": { - "operationId": "getEntity@Labels", + "operationId": "getEntity@Parameters", "parameters": [ { "in": "path", @@ -49898,7 +59731,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -49907,7 +59740,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -49915,8 +59748,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -49962,23 +59796,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Label", + "summary": "Get a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -49988,7 +59822,7 @@ } }, "patch": { - "operationId": "patchEntity@Labels", + "operationId": "patchEntity@Parameters", "parameters": [ { "in": "path", @@ -50008,7 +59842,7 @@ }, { "description": "Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').", - "example": "title==someString;description==someString;attribute.id==321", + "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { @@ -50017,7 +59851,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "attribute", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -50025,8 +59859,9 @@ "schema": { "items": { "enum": [ - "attributes", - "attribute", + "userIdentifiers", + "createdBy", + "modifiedBy", "ALL" ], "type": "string" @@ -50040,12 +59875,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelPatchDocument" + "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } } }, @@ -50056,23 +59891,118 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiLabelOutDocument" + "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Label (beta)", + "summary": "Patch a Parameter", "tags": [ - "Labels", + "Parameters", "entities", - "label-controller" + "parameter-controller" + ], + "x-gdc-security-info": { + "description": "Contains minimal permission level required to manage this object type.", + "permissions": [ + "MANAGE" + ] + } + }, + "put": { + "operationId": "updateEntity@Parameters", + "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", + "explode": false, + "in": "query", + "name": "include", + "required": false, + "schema": { + "items": { + "enum": [ + "userIdentifiers", + "createdBy", + "modifiedBy", + "ALL" + ], + "type": "string" + }, + "type": "array" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterInDocument" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + }, + "application/vnd.gooddata.api+json": { + "schema": { + "$ref": "#/components/schemas/JsonApiParameterOutDocument" + } + } + }, + "description": "Request successfully processed" + } + }, + "summary": "Put a Parameter", + "tags": [ + "Parameters", + "entities", + "parameter-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50082,9 +60012,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { + "/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts": { "get": { - "operationId": "getAllEntities@MemoryItems", + "operationId": "getAllEntities@ReportPageLayouts", "parameters": [ { "in": "path", @@ -50186,23 +60116,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Memory Items", + "summary": "Get all Report Page Layouts", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50212,7 +60142,7 @@ } }, "post": { - "operationId": "createEntity@MemoryItems", + "operationId": "createEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -50270,12 +60200,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPostOptionalIdDocument" } } }, @@ -50286,23 +60216,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Memory Items", + "summary": "Post Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50312,88 +60242,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { - "post": { - "operationId": "searchEntities@MemoryItems", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "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/JsonApiMemoryItemOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "AI", - "entities", - "memory-item-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/reportPageLayouts/{objectId}": { "delete": { - "operationId": "deleteEntity@MemoryItems", + "operationId": "deleteEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -50417,11 +60268,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Memory Item", + "summary": "Delete a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50431,7 +60282,7 @@ } }, "get": { - "operationId": "getEntity@MemoryItems", + "operationId": "getEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -50516,23 +60367,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Memory Item", + "summary": "Get a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50542,7 +60393,7 @@ } }, "patch": { - "operationId": "patchEntity@MemoryItems", + "operationId": "patchEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -50595,12 +60446,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutPatchDocument" } } }, @@ -50611,23 +60462,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Memory Item", + "summary": "Patch a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50637,7 +60488,7 @@ } }, "put": { - "operationId": "updateEntity@MemoryItems", + "operationId": "updateEntity@ReportPageLayouts", "parameters": [ { "in": "path", @@ -50690,12 +60541,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutInDocument" } } }, @@ -50706,23 +60557,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" + "$ref": "#/components/schemas/JsonApiReportPageLayoutOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Memory Item", + "summary": "Put a Report Page Layout", "tags": [ - "AI", + "Reports", "entities", - "memory-item-controller" + "report-page-layout-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -50732,9 +60583,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/metrics": { + "/api/v1/entities/workspaces/{workspaceId}/reportTemplates": { "get": { - "operationId": "getAllEntities@Metrics", + "operationId": "getAllEntities@ReportTemplates", "parameters": [ { "in": "path", @@ -50770,7 +60621,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -50779,15 +60630,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -50843,23 +60687,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiReportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiReportTemplateOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Metrics", + "summary": "Get all Report Templates", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -50869,7 +60713,7 @@ } }, "post": { - "operationId": "createEntity@Metrics", + "operationId": "createEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -50881,7 +60725,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -50890,15 +60734,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -50934,12 +60771,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePostOptionalIdDocument" } } }, @@ -50950,114 +60787,35 @@ "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" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutList" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "The search endpoint (beta)", + "summary": "Post Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-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}/reportTemplates/{objectId}": { "delete": { - "operationId": "deleteEntity@Metrics", + "operationId": "deleteEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -51081,11 +60839,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Metric", + "summary": "Delete a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51095,7 +60853,7 @@ } }, "get": { - "operationId": "getEntity@Metrics", + "operationId": "getEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -51124,7 +60882,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -51133,15 +60891,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -51187,23 +60938,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Metric", + "summary": "Get a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51213,7 +60964,7 @@ } }, "patch": { - "operationId": "patchEntity@Metrics", + "operationId": "patchEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -51242,7 +60993,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -51251,15 +61002,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -51273,12 +61017,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricPatchDocument" + "$ref": "#/components/schemas/JsonApiReportTemplatePatchDocument" } } }, @@ -51289,23 +61033,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Metric", + "summary": "Patch a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51315,7 +61059,7 @@ } }, "put": { - "operationId": "updateEntity@Metrics", + "operationId": "updateEntity@ReportTemplates", "parameters": [ { "in": "path", @@ -51344,7 +61088,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", + "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", @@ -51353,15 +61097,8 @@ "items": { "enum": [ "userIdentifiers", - "facts", - "attributes", - "labels", - "metrics", - "datasets", - "parameters", "createdBy", "modifiedBy", - "certifiedBy", "ALL" ], "type": "string" @@ -51375,12 +61112,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricInDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateInDocument" } } }, @@ -51391,23 +61128,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiMetricOutDocument" + "$ref": "#/components/schemas/JsonApiReportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Metric", + "summary": "Put a Report Template", "tags": [ - "Metrics", + "Reports", "entities", - "metric-controller" + "report-template-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51417,9 +61154,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters": { + "/api/v1/entities/workspaces/{workspaceId}/reports": { "get": { - "operationId": "getAllEntities@Parameters", + "operationId": "getAllEntities@Reports", "parameters": [ { "in": "path", @@ -51521,23 +61258,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiReportOutList" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" + "$ref": "#/components/schemas/JsonApiReportOutList" } } }, "description": "Request successfully processed" } }, - "summary": "Get all Parameters", + "summary": "Get all Reports", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51547,7 +61284,7 @@ } }, "post": { - "operationId": "createEntity@Parameters", + "operationId": "createEntity@Reports", "parameters": [ { "in": "path", @@ -51605,12 +61342,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" + "$ref": "#/components/schemas/JsonApiReportPostOptionalIdDocument" } } }, @@ -51621,23 +61358,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Post Parameters", + "summary": "Post Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51647,88 +61384,9 @@ } } }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { - "post": { - "operationId": "searchEntities@Parameters", - "parameters": [ - { - "in": "path", - "name": "workspaceId", - "required": true, - "schema": { - "type": "string" - } - }, - { - "in": "query", - "name": "origin", - "required": false, - "schema": { - "default": "ALL", - "description": "Defines scope of origin of objects. All by default.", - "enum": [ - "ALL", - "PARENTS", - "NATIVE" - ], - "type": "string" - } - }, - { - "in": "header", - "name": "X-GDC-VALIDATE-RELATIONS", - "required": false, - "schema": { - "default": false, - "type": "boolean" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/EntitySearchBody" - } - } - }, - "description": "Search request body with filter, pagination, and sorting options", - "required": true - }, - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" - } - }, - "application/vnd.gooddata.api+json": { - "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutList" - } - } - }, - "description": "Request successfully processed" - } - }, - "summary": "The search endpoint (beta)", - "tags": [ - "Parameters", - "entities", - "parameter-controller" - ], - "x-gdc-security-info": { - "description": "Contains minimal permission level required to view this object type.", - "permissions": [ - "VIEW" - ] - } - } - }, - "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { + "/api/v1/entities/workspaces/{workspaceId}/reports/{objectId}": { "delete": { - "operationId": "deleteEntity@Parameters", + "operationId": "deleteEntity@Reports", "parameters": [ { "in": "path", @@ -51752,11 +61410,11 @@ "$ref": "#/components/responses/Deleted" } }, - "summary": "Delete a Parameter", + "summary": "Delete a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51766,7 +61424,7 @@ } }, "get": { - "operationId": "getEntity@Parameters", + "operationId": "getEntity@Reports", "parameters": [ { "in": "path", @@ -51851,23 +61509,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Get a Parameter", + "summary": "Get a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", @@ -51877,7 +61535,7 @@ } }, "patch": { - "operationId": "patchEntity@Parameters", + "operationId": "patchEntity@Reports", "parameters": [ { "in": "path", @@ -51930,12 +61588,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterPatchDocument" + "$ref": "#/components/schemas/JsonApiReportPatchDocument" } } }, @@ -51946,23 +61604,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Patch a Parameter", + "summary": "Patch a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -51972,7 +61630,7 @@ } }, "put": { - "operationId": "updateEntity@Parameters", + "operationId": "updateEntity@Reports", "parameters": [ { "in": "path", @@ -52025,12 +61683,12 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiReportInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterInDocument" + "$ref": "#/components/schemas/JsonApiReportInDocument" } } }, @@ -52041,23 +61699,23 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { - "$ref": "#/components/schemas/JsonApiParameterOutDocument" + "$ref": "#/components/schemas/JsonApiReportOutDocument" } } }, "description": "Request successfully processed" } }, - "summary": "Put a Parameter", + "summary": "Put a Report", "tags": [ - "Parameters", + "Reports", "entities", - "parameter-controller" + "report-controller" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", @@ -52105,7 +61763,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -52118,6 +61776,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -52216,7 +61875,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -52229,6 +61888,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -52459,7 +62119,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -52472,6 +62132,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -52577,7 +62238,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -52590,6 +62251,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -52679,7 +62341,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", + "example": "user,userGroup,facts,attributes,labels,computedAttributes,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", @@ -52692,6 +62354,7 @@ "facts", "attributes", "labels", + "computedAttributes", "metrics", "datasets", "parameters", @@ -52790,7 +62453,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -52804,6 +62467,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -52836,7 +62500,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,page,all", + "example": "metaInclude=permissions,origin,page,all", "explode": false, "in": "query", "name": "metaInclude", @@ -52845,6 +62509,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "page", "all", @@ -52901,7 +62566,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -52915,6 +62580,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -52929,7 +62595,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -52938,6 +62604,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -53144,7 +62811,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -53158,6 +62825,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -53181,7 +62849,7 @@ }, { "description": "Include Meta objects.", - "example": "metaInclude=origin,all", + "example": "metaInclude=permissions,origin,all", "explode": false, "in": "query", "name": "metaInclude", @@ -53190,6 +62858,7 @@ "description": "Included meta objects", "items": { "enum": [ + "permissions", "origin", "all", "ALL" @@ -53262,7 +62931,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -53276,6 +62945,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", @@ -53364,7 +63034,7 @@ }, { "description": "Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", - "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", + "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,computedAttributes,datasets", "explode": false, "in": "query", "name": "include", @@ -53378,6 +63048,7 @@ "labels", "metrics", "parameters", + "computedAttributes", "datasets", "createdBy", "modifiedBy", diff --git a/schemas/gooddata-result-client.json b/schemas/gooddata-result-client.json index 9b77543e6..b77c3e45f 100644 --- a/schemas/gooddata-result-client.json +++ b/schemas/gooddata-result-client.json @@ -1482,10 +1482,6 @@ } }, "servers": [ - { - "description": "Generated server url", - "url": "https://staging.dev-latest.stg11.panther.intgdc.com" - }, { "description": "GoodData.CN endpoint", "url": "/" diff --git a/schemas/gooddata-scan-client.json b/schemas/gooddata-scan-client.json index 337071262..3216a4d5c 100644 --- a/schemas/gooddata-scan-client.json +++ b/schemas/gooddata-scan-client.json @@ -789,7 +789,8 @@ "MONGODB", "CRATEDB", "AILAKEHOUSE", - "DENODO" + "DENODO", + "TRINO" ], "example": "POSTGRESQL", "type": "string" @@ -1255,7 +1256,7 @@ }, "/api/v1/actions/dataSources/{dataSourceId}/scanStatistics": { "post": { - "description": "(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values.", + "description": "(BETA) Reads the statistics the database already maintains in its own catalog, without scanning any data. Supported for StarRocks (both internal catalog for native/PIPE tables and external catalog for Iceberg tables), BigQuery, PostgreSQL, Redshift, Snowflake, Vertica, SQL Server, Azure SQL, MySQL, MariaDB and SingleStore. Statistics include row counts and data sizes, and, where the database exposes them, NDV (number of distinct values), null counts and min/max values. Returns an empty result for a data source whose database exposes no such catalog. Also returns an empty result for a data source that sets disableStatistics.", "operationId": "scanStatistics", "parameters": [ { @@ -1289,7 +1290,7 @@ "description": "OK" } }, - "summary": "(BETA) Collect physical table and column statistics from a StarRocks data source", + "summary": "(BETA) Collect physical table and column statistics from a data source", "tags": [ "Data Source - Statistics", "actions"